WorkSite Connector Administration Guide

Autonomy

WorkSite ConnectorAdministration Guide

Version 7.4Document Revision 1

26 May 2009

Notice

This 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 Copyrights

Copyright 2009 Autonomy Corporation plc and all its affiliates. All rights reserved. Autonomy AnswerTM, 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, VideoLoggerTM, 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 Users

If this product is acquired under the terms of a DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of 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., One Market Plaza, Spear Tower, Suite 1900, San Francisco, CA. 94105, US.

27 May 2009

Copyright Notice

Contents

Preface ............................................................................................................................................. 9

About this Guide............................................................................................................................ 9

Version .................................................................................................................................. 9

Guide Organization ................................................................................................................ 9

Notational Conventions .........................................................................................................11

Command-line Syntax Conventions ......................................................................................12

Notices ..................................................................................................................................13

Related Documentation ...............................................................................................................13

Support and Contact Information .................................................................................................14

Download the Latest Documentation ....................................................................................14

Contact Autonomy Technical Support ...................................................................................15

Contact Autonomy ................................................................................................................15

Part 1 Getting Started

Chapter 1 Introduction ................................................................................................................................. 19

Overview ......................................................................................................................................19

About Connector Framework Server ............................................................................................20

System Architecture .....................................................................................................................21

Import Process .............................................................................................................................22

Chapter 2 Configure WorkSite Connector ............................................................................................ 23

WorkSite Connector Configuration File ........................................................................................24

Modify Parameters .......................................................................................................................24

Enter Boolean Values .....................................................................................................24

Enter String Values ........................................................................................................24

WorkSite Connector Administration Guide 1

• • • •••

Contents

2

Configuration File Sections.......................................................................................................... 25

Service Section .................................................................................................................... 25

Server Section ...................................................................................................................... 25

Logging Section ................................................................................................................... 25

Connector Section ................................................................................................................ 26

Ingestion Section .................................................................................................................. 26

FetchTasks Section .............................................................................................................. 27

TaskName Section ............................................................................................................... 27

Example Configuration File.......................................................................................................... 28

Start and Stop the Connector ..................................................................................................... 29

Start the Connector .............................................................................................................. 30

Stop a Connector ................................................................................................................. 30

Encrypt Passwords ..................................................................................................................... 31

Set Up Log Streams ................................................................................................................... 32

Set Up Secure Socket Layer Connections .................................................................................. 34

Chapter 3 Configure Connector Framework Server......................................................................... 37

Connector Framework Server Configuration File ......................................................................... 37

Modify Parameters ...................................................................................................................... 38

Enter Boolean Values .................................................................................................... 38

Enter String Values ........................................................................................................ 38

Configure Connector Framework Server .................................................................................... 39

Use Lua Scripts .......................................................................................................................... 39

Configure a Lua Script .......................................................................................................... 40

Write a Lua Script ................................................................................................................. 40

Supported Functions ...................................................................................................... 41

Change the Value of a Field ................................................................................................. 41

Add a Field ........................................................................................................................... 42

Sections ............................................................................................................................... 42

Example Script ..................................................................................................................... 42

C Function Reference .......................................................................................................... 43

Example Configuration File.......................................................................................................... 47

WorkSite Connector Administration Guide

• • • •••

Contents

Part 2 Parameter and Command Reference

Chapter 4 WorkSite Connector Parameters ......................................................................................... 51

Service Parameters .....................................................................................................................51

Server Parameters ......................................................................................................................52

Port .......................................................................................................................................52

AdminClients .........................................................................................................................52

QueryClients .........................................................................................................................53

Connector Parameters ................................................................................................................54

EnableIngestion ....................................................................................................................54

EnableScheduledTasks ........................................................................................................54

JavaClassPath ......................................................................................................................55

JavaConnectorClass .............................................................................................................56

JavaMaxMemoryMB .............................................................................................................56

ScheduleCycles ....................................................................................................................57

ScheduleRepeatSecs ...........................................................................................................57

ScheduleStartTime ...............................................................................................................58

TempDirectory ......................................................................................................................58

Ingestion Parameters ..................................................................................................................59

BatchSize .............................................................................................................................59

Host ......................................................................................................................................59

IndexDatabase ......................................................................................................................60

Port .......................................................................................................................................60

SharedPath ...........................................................................................................................60

FetchTasks/TaskName Parameters ............................................................................................61

AllVersions ............................................................................................................................61

DatabaseHost .......................................................................................................................62

DatabaseInstanceName .......................................................................................................62

DatabaseIntegratedAuth .......................................................................................................62

DatabaseName .....................................................................................................................63

DatabasePassword ...............................................................................................................63

DatabasePort ........................................................................................................................64

DatabaseUserName .............................................................................................................64

DatabaseVendor ...................................................................................................................64

DefaultDateRange ................................................................................................................65

DynamicParameterNameN ...................................................................................................65

DynamicParameterValueN ...................................................................................................66

FirstDocument ......................................................................................................................66


• • • •••

Contents

4

LastDocument ...................................................................................................................... 66

MappedSecurity ................................................................................................................... 67

MaxDocuments .................................................................................................................... 67

N .......................................................................................................................................... 68

Number ................................................................................................................................ 68

SecurityType ........................................................................................................................ 69

WorksiteLibrary .................................................................................................................... 69

Chapter 5 Connector Framework Server Parameters...................................................................... 71

Service Parameters .................................................................................................................... 72

Server Parameters ..................................................................................................................... 72

AdminClients ........................................................................................................................ 72

Port ...................................................................................................................................... 73

QueryClients ........................................................................................................................ 73

Actions Parameters .................................................................................................................... 74

MaximumThreads ............................................................................................................... 74

Import Tasks Parameters ........................................................................................................... 74

PostN .................................................................................................................................. 74

PreN .................................................................................................................................... 75

HashLua .............................................................................................................................. 76

ImportStatisticsFile .............................................................................................................. 76

Import Service Parameters ......................................................................................................... 77

ExtractDirectory ................................................................................................................... 77

ImportFamilyRootExcludeFmtCSV ...................................................................................... 77

ImportHashFamilies ............................................................................................................ 78

ImportInheritFieldsCSV ....................................................................................................... 78

ImportMergeMails ............................................................................................................... 79

KeyviewDirectory ................................................................................................................ 79

RevisionMarks ..................................................................................................................... 80

ThreadCount ....................................................................................................................... 80

Indexing Parameters .................................................................................................................. 81

DREHostN .......................................................................................................................... 81

ErrorTaskN .......................................................................................................................... 81

IndexBatchSize ................................................................................................................... 82

IndexTimeInterval ................................................................................................................ 82


• • • •••

Contents

Chapter 6 License Parameters .................................................................................................................. 83

Full .............................................................................................................................................84

Holder ........................................................................................................................................84

Key .............................................................................................................................................84

LicenseServerACIPort ................................................................................................................85

LicenseServerHost .....................................................................................................................86

LicenseServerTimeout ...............................................................................................................86

LicenseServerRetries .................................................................................................................87

Operation ...................................................................................................................................87

Chapter 7 Logging Parameters ................................................................................................................. 89

LogArchiveDirectory ...................................................................................................................90

LogCompressionMode ...............................................................................................................91

LogDirectory ...............................................................................................................................91

LogEcho .....................................................................................................................................92

LogEncryption ............................................................................................................................93

LogEncryptionKeys ....................................................................................................................93

LogExpireAction .........................................................................................................................94

LogFile .......................................................................................................................................95

LogHistorySize ...........................................................................................................................96

LogLevel ....................................................................................................................................96

LogLevelMatch ...........................................................................................................................97

LogMaxLineLength .....................................................................................................................98

LogMaxOldFiles .........................................................................................................................99

LogMaxSizeKBs .......................................................................................................................100

LogOldAction ............................................................................................................................100

LogOutputLogLevel ..................................................................................................................101

LogSysLog ...............................................................................................................................102

LogTime ...................................................................................................................................102

LogTypeCSVs ..........................................................................................................................103

Chapter 8 Secure Socket Layer Parameters ...................................................................................... 105

SSLConfig ................................................................................................................................106

SSLCACertificate .....................................................................................................................108

SSLCertificate ..........................................................................................................................108

SSLCheckCertificate ................................................................................................................109

SSLCheckCommonName ........................................................................................................109

SSLMethod ..............................................................................................................................110


• • • •••

Contents

6

SSLPrivateKey ........................................................................................................................ 110

SSLPrivateKeyPassword ..........................................................................................................111

Chapter 9 Service Actions........................................................................................................................ 113

Action Syntax ............................................................................................................................ 114

GetConfig ............................................................................................................................... 114

GetLogStream ........................................................................................................................ 115

GetLogStreamNames ............................................................................................................. 115

GetStatistics ........................................................................................................................... 116

GetStatus ............................................................................................................................... 119

GetStatusInfo .......................................................................................................................... 120

MergeConfig ........................................................................................................................... 121

SetConfig ................................................................................................................................ 122

Stop ........................................................................................................................................ 122

Chapter 10 Service Action Parameters.................................................................................................. 125

Config ....................................................................................................................................... 125

DeleteKeyN .............................................................................................................................. 126

FromDisk .................................................................................................................................. 127

Name ........................................................................................................................................ 127

Tail ........................................................................................................................................... 127

KeyN ......................................................................................................................................... 128

ValueN ...................................................................................................................................... 129

Chapter 11 Service Configuration Parameters ................................................................................... 131

ServiceACIMode ...................................................................................................................... 132

ServiceControlClients .............................................................................................................. 132

ServiceHost ............................................................................................................................. 133

ServicePort .............................................................................................................................. 133

ServiceStatusClients ............................................................................................................... 134


• • • •••

Contents

Appendixes

Appendix AKeyView Format Codes ..........................................................................................................137

KeyView Classes ......................................................................................................................138

KeyView Formats ......................................................................................................................139

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

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


• • • •••

Contents

8
• • • •••

Preface

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

About this Guide

Related Documentation

Support and Contact Information

About this Guide

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

Version

The information in this guide is current as of WorkSite Connector version 7.4. The content was last modified 26 May 2009. Corrections or updates to this information may be available through the Autonomy Support site; see “Support and Contact Information” on page 14.

Guide Organization

This guide includes the following:

Part 1, “Getting Started” provides an overview of the WorkSite Connector and as well as configuration information for the connector and the Connector Framework server and includes the following chapters:

Chapter 1, “Introduction” describes WorkSite Connector and the file polling process.


• • • •••

Preface

10

Chapter 2, “Configure WorkSite Connector” describes how to configure the parameters that determine how the WorkSite Connector operates.

Chapter 3, “Configure Connector Framework Server” describes how to set up and use the Connector Framework server.

Part 2, “Parameter and Command Reference” describes some of the configuration parameters and action commands used by the WorkSite Connector and includes the following chapters:

Chapter 4, “WorkSite Connector Parameters” describes the parameters used to determine how WorkSite Connector operates.

Chapter 5, “Connector Framework Server Parameters” lists the Connector Framework Server configuration parameters.

Chapter 6, “License Parameters” describes the license configuration parameters that specify licensing details.

Chapter 7, “Logging Parameters” 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, “Secure Socket Layer Parameters” describes the configuration parameters used to configure Secure Socket Layer (SSL) connections between components.

Chapter 9, “Service Actions” describes standard service and control commands.

Chapter 10, “Service Action Parameters” describes the parameters that can be used with Service actions.

Chapter 11, “Service Configuration Parameters” describes Service configuration parameters that determine which machines are permitted to use and control a service.

“Appendixes” includes the following appendix:

“KeyView Format Codes” lists the KeyView format classes and codes used with Connector Framework server.


• • • •••

About this Guide

Notational Conventions

This guide uses the following conventions.

Convention Usage

Bold User-interface elements such as a menu item or button. For example:

Click Cancel to halt the operation.

Italics Document titles and new terms. For example:

For more information, see the IDOL Server Administration Guide.

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

monospace font File names, paths, and code. For example:

The FileSystemConnector.cfg file is installed in C:\Autonomy\FileSystemConnector\

monospace bold Data typed by the user. For example:

Type run at the command prompt.

In the User Name field, type Admin.

monospace italics Replaceable strings in file paths and code. For example:

user UserName


• • • •••

Preface

12

Command-line Syntax Conventions

This guide uses the following command-line syntax conventions.

The 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. For example:

[ -create ]

| Bars indicate “either | or” choices. For example:

[ option1 ] | [ option2 ]

In this example, you must choose between option1 and option2.

{ required } Braces describe required syntax in which you have a choice and that at least one choice is required. For example:

{ [ option1 ] [ option2 ] }

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

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

variable

<variable>

Italics specify items to be replaced by actual values. For example:

-merge filename1

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

... Ellipses indicate repetition of the same pattern. For example:

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

where the ellipses specify, filename4, and so on.


• • • •••


Notices

This guide uses the following notices:


The following documents provide more details on WorkSite Connector:

IDOL Administration User Guide

IDOL Administration provides a distributed, Web-based infrastructure for managing IDOL components and services. The IDOL Administration manual describes how to administer IDOL through the IDOL Administration Dashboard and Dashboard console.

IDOL Server Administration Guide

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

CAUTION A caution indicates an action can result in the loss of data.

IMPORTANT An important note provides information that is essential to completing a task.

NOTE A note provides information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases—for example, memory limitations, equipment configurations, or details that apply to specific versions of the software.

TIP A tip provides additional information that makes a task easier or more productive.


• • • •••

Preface

14

Distributed Index Handler (DIH) Administration 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) Administration 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) Administration Guide

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


Read this section to obtain the latest product documentation, request technical support, or contact Autonomy.

Download the Latest Documentation

You can retrieve the latest available product documentation from Autonomy’s Knowledge Base on the Customer Support site.

To download the latest document revisions

1. Type this URL in your Web browser's address field:

https://customers.autonomy.com

2. Click Log In and type your e-mail address and password.

3. Click Sign in.

4. Click Knowledge Base.

5. Type query text or select a category to filter your search for documentation. The most recently added documents display at the top of the results list.

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


• • • •••



The version number associated with a document (for example, version 7.4) is the product version that the document describes. If a document has a revision number (for example, Revision 5), the document has been revised since it was first released with the specified product version. The Knowledge Base contains the latest available revision of any document.

Contact Autonomy Technical Support

Autonomy Technical Support exists to provide you with prompt and accurate resolutions to difficulties relating to using Autonomy software products. You can contact Technical Support using any of the following methods:

Call or e-mail the support group at the location that is nearest to you:

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 sign-up instructions on the home page.

Contact Autonomy

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

Europe and Worldwide North and South America

E-mail: [email protected]

Telephone: 00 800 4837 4890 (UK, Germany, Spain, Netherlands, France) +44 (0) 800 0 282 858 (UK only)

Hours: 09:00 to 17:00 (GMT+1)


Telephone: 1 877 333 77441 403 294 1107 (Canada direct)

Hours: 07:00 to 18:00 MST (GMT-7)

Europe and Worldwide North and South America


Telephone: +44 (0) 1223 448 000Fax: +44 (0) 1223 448 001

Autonomy Corporation plcCambridge Business ParkCowley Road, Cambridge, CB4 0WZ, UK


Telephone: 1 415 243 9955Fax: 1 415 243 9984

Autonomy, Inc.One Market Plaza, Spear Tower, Suite 1900San Francisco, CA. 94105, US


• • • •••

mailto:[email protected]





Preface

16
• • • •••

PART 1 Getting Started

This section provides an overview of the WorkSite Connector and as well as configuration information for the connector and the Connector Framework server. It includes the following chapters:

Introduction

Configure WorkSite Connector

Configure Connector Framework Server

Part 1 Getting Started

18 WorkSite Connector Administration Guide

• • • •••

CHAPTER 1 IntroductionThis chapter provides an overview of the WorkSite Connector. It contains the following sections:

Overview

About Connector Framework Server

System Architecture

Import Process

Overview

WorkSite Connector is an Autonomy connector that automatically aggregates information from a WorkSite server and sends it to Connector Framework server (CFS), which then processes the information and indexes it into an Autonomy IDOL server.


• • • •••

Chapter 1 Introduction

20

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

See your IDOL server’s manual for further details.

Related Topics


About Connector Framework Server

The Connector Framework server (CFS) (also known as the Ingestion server) receives information from various connectors, which it then processes and indexes into an IDOL server. A single CFS can be configured to work with multiple connectors and send documents to multiple IDOL servers or Distributed Index Handlers (DIH). In addition, the server can execute predefined tasks on documents after they are imported or if errors occur.

CFS filters text from a variety of document types with KeyView filters, which are document-specific readers used for text extraction. Users generally do not access KeyView directly; however, the parameter ImportFamilyRootExcludeFmtCSV requires that you identify the desired KeyView document formats.

ImportFamilyRootExcludeFmtCSV

KeyView Format Codes

Agents

Alerting

Categorization

Channels

Clustering

Collaboration

Dynamic Thesaurus

Expertise

Hyperlinking

Mailing

Profiling

Retrieval

Spelling Correction

Summarization

Taxonomy Generation


• • • •••

System Architecture

System Architecture

There are several ways to install the Connector Framework server. The simplest installation consists of a single CFS, single connector, and single IDOL server.

It is also possible to have more complex configurations, consisting of more than one connector, a Distributed Index Handler (DIH), multiple IDOL servers, or some combination of these options.


• • • •••

Chapter 1 Introduction

22

Import Process

The import process consists of the following basic steps:

1. The connector sends documents from the data repository to the CFS.

2. Pre-import tasks are performed, which are typically defined in Lua scripts.

3. KeyView filters the document content.

4. Post-import tasks are performed, as defined in the PostN parameters.

5. Optionally, a backup IDX or XML file is created.

6. The data is indexed into IDOL server, or sent to a DIH.


• • • •••

CHAPTER 2 Configure WorkSite ConnectorThis chapter describes how to configure the parameters that determine how the WorkSite Connector operates. The configuration settings are stored in the connector configuration file located in the WorkSite Connector installation directory. You can modify the parameters directly in the configuration file using a text editor.

This chapter includes the following sections:

WorkSite Connector Configuration File

Modify Parameters

Configuration File Sections

Example Configuration File

Start and Stop the Connector

Encrypt Passwords

Set Up Log Streams

Set Up Secure Socket Layer Connections


• • • •••

Chapter 2 Configure WorkSite Connector

24

WorkSite Connector Configuration File

The parameters that determine how WorkSite Connector operates appear in the InstallationName configuration file, located in your installation directory. You can modify these parameters to customize WorkSite Connector according to your requirements.

Modify Parameters

The following section describes how to enter parameter values in the configuration file.

Enter Boolean Values

The following settings for Boolean parameters are interchangeable:

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

Enter String Values

Some parameters require string values that contain quotation marks. Escape each quotation mark by inserting a backslash before it.

For example:

FIELDSTART0=""

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 each quotation mark in the string by inserting a backslash before it.

For example:

ParameterName="",dog,bird,"wing,beak",turtle


• • • •••



The WorkSite Connector configuration file contains the following sections:

[Service][Server][Logging][Connector][Ingestion][FetchTasks][TaskName]

Service Section

The [Service] section contains parameters that determine which machines are permitted to use and control the WorkSite Connector service. For example:

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

Server Section

This section contains general parameters for indexing and querying.

For example:

[Server]Port=7008QueryClients=10.1.1.*,127.0.0.1AdminClients=10.1.1.10,127.0.0.1

Logging Section

The [Logging] section lists the logging streams you want to set up to create separate log files for different log message types (application, action, and synchronize). It also contains a subsection for each of the listed logging streams, in which you can configure the parameters that determine how each stream is logged. For example:

[Logging]LogLevel=FULLLogDirectory=C:\WorkSiteConnector\logs


• • • •••


26

0=ApplicationLogStream1=ActionLogStream2=SynchronizeLogStream

[ApplicationLogStream]LogFile=application.logLogTypeCSVs=applicationLogEcho=TRUE

[ActionLogStream]LogFile=action.logLogTypeCSVs=actionLogEcho=TRUE

[SynchronizeLogStream]LogFile=synchronize.logLogTypeCSVs=synchronize

Connector Section

[Connector]EnableIngestion=TRUETempDirectory=Temp

EnableScheduledTasks=TRUEScheduleCycles=-1ScheduleRepeatSecs=86400

JavaClassPath=JavaConnector.jar;WorksiteConnector.jar;wscrawler.jar; log4j-1.2.15.jar;commons-dbcp-1.2.2.jar;commons-pool-1.3.jar; sqljdbc.jarJavaConnectorClass=com/autonomy/connector/worksiteconnector/WorksiteConnector

Ingestion Section

The [Ingestion] section contains parameters that specify details for the Connector Framework server (also known as the Ingestion server). The server accepts data from the connector, generates an IDX or XML file, and sends the file to IDOL server for indexing.

[Ingestion]Host=localhostPort=7000BatchSize=100IndexDatabase=Default


• • • •••


FetchTasks Section

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

Number=10=MyTask1

TaskName Section

The [TaskName] section contains configuration parameters that only apply to the specified job. There must be a [TaskName] section for every job listed in the [FetchTasks] section. A parameter specified in a [TaskName] section overrides the same parameter defined in the [FetchTasks] section.

For example:

[MyTask1]DatabaseHost=dbhostDatabasePort=1433DatabaseName=mydbDatabaseUsername=userDatabasePassword=passwordDatabaseType=DatabaseIntegratedAuth=DatabaseInstanceName=

StartTime=EndTime=MaxDocuments=FirstDocument=LastDocument=

AllVersions=TRUECheckConnectivity=

MappedSecurity=TRUESecurityType=WORKSITE

Related Topics

Set Up Log Streams


• • • •••


28


[service]ServicePort=7009

[server]Port=7008QueryClients=*AdminClients=*

[Logging]LogLevel=FULLLogDirectory=logs0=ApplicationLogStream1=ActionLogStream2=SynchronizeLogStream

[ApplicationLogStream]LogFile=application.logLogTypeCSVs=applicationLogEcho=TRUE

[ActionLogStream]LogFile=action.logLogTypeCSVs=actionLogEcho=TRUE

[SynchronizeLogStream]LogFile=synchronize.logLogTypeCSVs=synchronize

[Connector]EnableIngestion=TRUETempDirectory=Temp

EnableScheduledTasks=TRUEScheduleCycles=-1ScheduleRepeatSecs=86400 JavaClassPath=JavaConnector.jar;WorksiteConnector.jar;wscrawler.jar; log4j-1.2.15.jar;commons-dbcp-1.2.2.jar;commons-pool-1.3.jar; sqljdbc.jarJavaConnectorClass=com/autonomy/connector/worksiteconnector/WorksiteConnector

[Ingestion]Host=localhostPort=7000


• • • •••


BatchSize=100IndexDatabase=Default

[FetchTasks]Number=10=MyTask1

[MyTask1]DatabaseHost=dbhostDatabasePort=1433DatabaseName=mydbDatabaseUsername=userDatabasePassword=passwordDatabaseType=DatabaseIntegratedAuth=DatabaseInstanceName=

StartTime=EndTime=MaxDocuments=FirstDocument=LastDocument=

AllVersions=TRUECheckConnectivity=

MappedSecurity=TRUESecurityType=WORKSITE


Use the following information to start and stop the WorkSite Connector.

NOTE You must start and stop the Connector Framework server separately from the WorkSite Connector.


• • • •••


30

Start the Connector

Once you have installed a connector, you are ready to run it. Start the connector using one of the following methods.

To start the connector using Windows Services

1. Open the Windows Services dialog box.

2. Select the ConnectorInstallName service, and click Start.

3. Close the Windows Services dialog box.

To start the connector by running the executable

1. In the connector installation directory, locate the connector executable called ConnectorInstallName.exe.

2. On a command line, enter ConnectorInstallName.exe -run.

Stop a Connector

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

To stop the connector using Windows Services

1. Open the Windows Services dialog box.

2. Select the ConnectorInstallName service, and click Stop.

3. Close the Windows Services dialog box.

To stop the connector service by sending a command to the service port

Type the following command in the address bar of your browser:

http://host:ServicePort/action=stop

where,

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

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


• • • •••

Encrypt Passwords

Encrypt Passwords

For added security, it is recommended all passwords be encrypted before they are entered into a configuration field. To encrypt passwords, follow the steps relevant to your operating system.

To encrypt passwords

1. At a command prompt, change directories to InstallDir\ConnectorName.

2. Enter one of the following strings:

autpassword -e -tEncryptionType [options] PasswordString

autpassword -d PasswordString

autpassword -x -tEncryptionType [options]

where,

Option Description

-e Encrypts the password.

-d Decrypts the password.

-x Performs the operation specified by the -o option. See Options.


• • • •••


32

Example:

autpassword -e -tBASIC -c./Config.cfg -sDefault -pPassword passw0rautpassword -d passw0rautpassword -x -tAES -oKeyFile=./MyKeyFile.ky

Set Up Log Streams

If the default logging does not suit your environment, you can set up your own log streams. Each log stream creates a separate log file in which specific log message types (for example, action, index, application, or import) are logged.

To set up log streams

1. Open the configuration file in a text editor.

-tEncryptionType The type of encryption used. The following options are available:

Basic

AES

PasswordString The password to encrypt or decrypt.

Options Options can be one of the following:

-oOptionName=OptionValue. OptionName can be:

KeyFile. Specifies the path and filename of a keyfile. It should contain 64 hexadecimal characters. This option is only available with the AES encryption type and the -x option.

-c. The configuration filename in which to write the encrypted password. This option is only available with the -e argument.

-s. The name of the section in the configuration file in which to write the password. This option is only available with the -e argument.

-p. The parameter name in which to write the encrypted password. This option is only available with the -e argument.

When writing the password to a configuration file, you must specify all related options: -c, -s, and -p.

Option Description


• • • •••

Set Up Log Streams

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


• • • •••


34

loghistorysize=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.


You can configure Secure Socket Layer (SSL) connections between WorkSite Connector and other servers. Set the SSLConfig parameter in the job section to configure connections for outgoing index calls. Set the SSLConfig parameter in the [Default] section to configure connections for incoming ACI calls.

To configure an incoming SSL connection

1. Open the WorkSite Connector configuration file in a text editor.

2. Find the [Default] section.

3. Add the SSLConfig parameter to specify the section in which you have set the SSL details for the connection, usually SSLOptionN. For example:

[Default]...SSLConfig=SSLOption0

4. Create a corresponding [SSLOptionN] section. The SSLOption entry must contain the SSLMethod, SSLCertificate, and SSLPrivateKey parameters. For example:

[SSLOption0]SSLMethod=SSLV23


• • • •••


SSLCertificate=host1.crtSSLPrivateKey=host1.key


6. Restart WorkSite Connector to execute your changes.

To configure outgoing SSL connections

1. Open the WorkSite Connector configuration file in a text editor.

2. Find the job section.

3. Add the SSLConfig parameter to specify the section in which you have set the SSL details for the connection, usually SSLOptionN. For example:

[Job]...SSLConfig=SSLOption1

4. Create a corresponding [SSLOptionN] section. The SSLOption entry must contain the SSLMethod, SSLCertificate, and SSLPrivateKey parameters. For example:

[SSLOption1]SSLMethod=SSLV23SSLCertificate=host2.crtSSLPrivateKey=host2.key


6. Restart WorkSite Connector to execute your changes.


• • • •••


36
• • • •••

CHAPTER 3 Configure Connector Framework ServerThis chapter describes how to configure the parameters that determine how the Connector Framework server (CFS) operates. This chapter contains the following sections:

Connector Framework Server Configuration File

Modify Parameters


Use Lua Scripts


Connector Framework Server Configuration File

The parameters that determine how Connector Framework server operates are in the ConnectorFramework.cfg file, located in the CFS installation directory. You can modify these parameters to customize the CFS according to your requirements.

The CFS supports all standard Server, Service, Logging, and License parameters.

Most of the specific import tasks are defined in Lua scripts; therefore, the Connector Framework server configuration requirements are quite minimal.


• • • •••

Chapter 3 Configure Connector Framework Server

38

Related Topics

Connector Framework Server Parameters


Modify Parameters

The following section describes how to enter parameter values in the configuration file.

Enter Boolean Values

The following settings for Boolean parameters are interchangeable:

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

Enter String Values

Some parameters require string values that contain quotation marks. Escape each quotation mark by inserting a backslash before it.

For example:

FIELDSTART0=""

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 each quotation mark in the string by inserting a backslash before it.

For example:

ParameterName="",dog,bird,"wing,beak",turtle


• • • •••



This section describes how to configure the basic Connector Framework server parameters.

To configure CFS

1. Open the CFS configuration file.

2. In the [Service] section, specify the service information.

3. In the [Server] section, specify server information.

4. In the [ImportTasks] section, configure how data is imported to IDX or XML before it is indexed into IDOL server.

5. In the [ImportService] section, specify details for Keyview and the service that imports documents into IDX or XML.

6. In the [Indexing] section, specify the details for the IDOL server(s) to which the CFS will send documents for indexing.

7. In the [Actions] section, configure how actions are sent to the CFS.

8. Save the configuration file.

Related Topics

Service Parameters

Server Parameters

Import Tasks Parameters

Import Service Parameters

Indexing Parameters

Actions Parameters

Use Lua Scripts

Connector Framework server can import or process data using Lua, an embedded scripting language.

A Lua script allows CFS to:

Call out to an external service, for example to alert a user.


• • • •••


40

Modify and insert document fields.

Interface with other libraries.

When data is imported, the script is run for each document. Scripts are written in Lua, a scripting language with simple procedural syntax. For more information on Lua, see:

http://www.lua.org/

CFS supports all standard Lua functions.

Configure a Lua Script

You can execute two types of script: pre-Lua or post-Lua. Pre-Lua scripts are run after the document data is extracted but before it is filtered, so the document contains metadata. Post-Lua scripts are run after the document data is filtered, so it also contains the document content.

Use this procedure to specify the location of the Lua script file.

To configure a Lua script

1. Stop the Connector Framework server.

2. Open the Connector Framework server configuration file in a text editor.

3. Locate the [ImportTasks] section, and enter a different value of PreN (for pre-Lua scripts) or PostN (for post-Lua scripts) for each script file. For example:

[ImportTasks]...Pre0=Lua:script1.luaPre1=Lua:script2.luaPost0=Lua:script3.lua

4. To enable family hashing, set the HashLua parameter.

5. Save the configuration file.

Write a Lua Script

The script should have this structure:

function handler(document)...


• • • •••

http://www.lua.org/

Use Lua Scripts

end

The handler function is called for each document and is passed a document object. This is an internal representation of the document being processed. Modifying this object will change the document.

Supported Functions

These functions are supported:

Related Topics

“Add a Field” on page 42

“Change the Value of a Field” on page 41

“Sections” on page 42

Change the Value of a Field

The findField function returns field objects when passed a field name. These fields cannot be modified directly. The document functions fieldGetValue and fieldSetValue allow you to modify a field.

For example:

local field = document:findField("CONTENT")local content = document:fieldGetValue(field)

NOTE You can write a library of useful functions to share between multiple scripts, which you can then include in the scripts by adding dofile(“library.lua”) to the top of the lua script outside of the handler function.

addChildField Creates a new nested XML field when passed a parent field and a name and value.

addField Creates a new field when passed a name and value.

findField Returns field objects when passed a field name.

fieldSetValue Sets a field value.

fieldGetValue Gets a field value.

getNextSection Gets the next section in a document, allowing you to perform find or add operations on every section.


• • • •••


42

content = content .. "\nCopyright MyCorp\n"document:fieldSetValue(field, content)

Add a Field

The addField document function creates a new field when passed a name and value.

For example:

document:addField("TEST","123");

The addChildField document function creates a new nested XML field when passed the parent field name and a name and value.

For example:

document:addChildField(“TEST”,”NESTED_TEST”,”123”);

Sections

The document object passed to the script's handler function in fact represents the first section of the document. This means the functions findField and addField only find from and add to the first section.

To perform operations on every section, use the getNextSection function. For example:

local section = documentwhile section do

-- Manipulate section

section = section:getNextSection()end

There is currently no support for adding or removing sections.

Example Script

For each document, this Lua script adds a COUNT field, a total sections count to the title, and a section number to the content of each section.

NOTE The COUNT is 1 for the first document and increases as long as the job is running.


• • • •••

Use Lua Scripts

doc_count = 0

function handler(document)

doc_count = doc_count + 1document:addField("COUNT",doc_count);local section_count = 0local section = document

while section dosection_count = section_count + 1field = section:findField("CONTENT")if field then

section:fieldSetValue(field, "Section "..section_count);

endsection = section:getNextSection()end

local field = document:findField("TITLE")if field then

document:fieldSetValue(field, document:fieldGetValue(field).." Total Sections "..section_count)

endend

C Function Reference

The Connector Framework server supports several C functions, which are listed in Table 1.

Table 1 Supported C functions

Function Description

convert_date_time Converts date and time formats using standard Autonomy syntax.

create_path Creates the specified directory tree.

create_uuid Creates a universally unique identifier.

encrypt_security_field Encrypts the ACL.


• • • •••


44

convert_date_time

Converts date and time formats using standard Autonomy syntax.

SyntaxString convert_date_time (String InputDateTime, String InputFormatCSV, String OutputFormat, [Boolean OutputGMT = false])

Arguments

DiscussionAll date and time input is treated as local time unless it contains explicit time zone information.

ReturnsDate and time in the desired format.

create_path

Creates the specified directory tree.

Syntaxvoid create_path (String Path)

gobble_whitespace Reduces multiple spaces to a single space.

hash_file Hashes specified file using the SH1 or MDA5 algorithm, or both.

hash_string Hashes specified string.

Arguments Type/Description

InputDateTime The date and time to be converted.

InputFormatCSV A comma-separated list of the possible date and time formats of the input.

OutputFormat The format of the date and time to be output.

OutputGMT Specifies whether to treat the date and time output as Greenwich Mean Time. Default is false.

Function Description


• • • •••

Use Lua Scripts

Arguments

create_uuid

Creates a universally unique identifier.

SyntaxString create_uuid()

ReturnsA universally unique identifier.

encrypt_security_field

Encrypts the ACL.

SyntaxString encrypt_security_field (String ACL)

Arguments

ReturnsAn encrypted string.

gobble_whitespace

Reduces multiple adjacent white spaces (tab, carriage return, space, and so on) in the specified field to a single space.

SyntaxString gobble_whitespace (String Input)


Path The path to be created.


ACL An Access Control List string.


• • • •••


46

Arguments

ReturnsA string without adjacent white spaces.

hash_file

Hashes the specified file using the SHA1 or MDA5 algorithm, or both.

SyntaxString, [String] hash_file (String FileName, String Algorithm1, [String Algorithm2])

Arguments

ReturnsThe hashed file.

hash_string

Hashes the specified string using the SHA1 or MDA5 algorithm.

SyntaxString hash_string (String StringToHash, String Algorithm)

Arguments


Input An input string.


FileName The name of the file to be specified.

Algorithm1 The type of algorithm to use. Must be either SHA1 or MDA5.

Algorithm2 The optional second type of algorithm to use. Must be whichever algorithm was not used in Algorithm1.


StringToHash The string to be hashed.

Algorithm The algorithm to use. Must be either SHA1 or MDA5.


• • • •••


ReturnsThe hashed input string.


This section contains a basic example configuration file, which meets the minimum configuration requirements.

[Service]Port=40030

[Server]Port=7000

[actions]MaximumThreads=10

[Indexing]DREHost=127.0.0.1ACIPort=9000IndexBatchSize=100IndexTimeInterval=60

[Logging]LogLevel=NORMALLogEcho=TRUE0=IndexLogStream1=ActionLogStream2=ImportLogStream

[ActionLogStream]LogFile=action.logLogTypeCSVs=action

[ImportLogStream]LogEcho=TRUELogFile=import.logLogTypeCSVs=import

[IndexLogStream]LogFile=indexer.logLogTypeCSVs=indexer

[ImportService]KeyviewDirectory=C:\Autonomy\ConfluenceConnectorJava\..\ConnectorFramework\filters


• • • •••


48

ExtractDirectory=C:\Autonomy\ConfluenceConnectorJava\..\ConnectorFramework\TempThreadCount=8ImportInheritFieldsCSV=AUTN_IDENTIFIER

[ImportTasks]Post0=IdxWriter:C:\Autonomy\ConfluenceConnectorJava\..\ConnectorFramework\IDXArchive\output.idx


• • • •••

PART 2 Parameter and Command ReferenceThis section describes some of the configuration parameters and action commands used by the WorkSite Connector and includes the following chapters:

WorkSite Connector Parameters

Connector Framework Server Parameters

License Parameters

Logging Parameters

Secure Socket Layer Parameters

Service Actions

Service Action Parameters

Service Configuration Parameters

Part 2 Parameter and Command Reference


• • • •••

CHAPTER 4 WorkSite Connector ParametersThis chapter describes the parameters that determine how WorkSite Connector operates. You can modify these parameters to customize WorkSite Connector to your needs.

Service Parameters

Server Parameters

Connector Parameters

Ingestion Parameters

FetchTasks/TaskName Parameters

Service Parameters

This section contains parameters that determine which machines are permitted to use and control the WorkSite Connector service.

Related Topics



• • • •••

Chapter 4 WorkSite Connector Parameters

52

Server Parameters

This section contains general parameters for indexing and querying.

Port

Specify the ACI port by which action commands are sent to the connector.

AdminClients

Specify the IP addresses or names of clients that can issue administrative commands to the ACI Port.

To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma).

Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector.

Type: Long

Default: 7008

Required: No

Allowed Range:

Minimum: 0Maximum: 2000000000

Recommended Range:


Configuration Section:

Server

Example: Port=7008

See Also: “QueryClients” on page 53 “AdminClients” on page 52

Type: String

Default: *.*.*.*

Required: No


• • • •••

Server Parameters

QueryClients

Specify the IP addresses or names of clients that can query the connector.




Server

Example: AdminClients=localhost,196.172.87.11

See Also: “Port” on page 52 “QueryClients” on page 53

Type: Strin

Default: *.*.*.*

Required: No


Server

Example: QueryClients=10.1.1..*,127.0.0.1

See Also: “Port” on page 52 “AdminClients” on page 52


• • • •••


54


These parameters enable features, set tempory directories, and so on. This section also contains Java settings.

EnableIngestion

Specify whether to ingest documents into IDOL. If this is set to false, documents are not ingested into IDOL. If this parameter is disabled, commands to process documents are ignored, but are logged (for testing only).

EnableScheduledTasks

Specify whether configured tasks in the main connector configuration are enabled. If this parameter is enabled, a synchronize action is sent according to the configured schedule. If this parameter is disabled, all actions must be generated externally.

Type: Boolean

Default: true

Required: No


Connector

Example: EnableIngestion=True

See Also:

Type: Boolean

Default: true

Required: No


Connector

Example: EnableScheduledTasks=True

See Also: “ScheduleCycles” on page 57“ScheduleRepeatSecs” on page 57“ScheduleStartTime” on page 58


• • • •••


JavaClassPath

Specify the CLASSPATH to use, including all dependencies of the connector. This must include the JavaConnector.jar and the class specified by the JavaConnectorClass parameter. For WorkSite Connector, this must include versions of

JavaConnector.jarWorkSiteConnector.jarwscrawler.jarlog4j-1.2.15.jarcommons-dbcp-1.2.2.jarcommons-pool-1.3.jarsqljdbc.jar

If the connector is run through Java directly (using the ConnectorLibJava library), the CLASSPATH and memory limits should be set on the command line. For example:

java -classpath <JAVA_CLASSPATH> com.autonomy.connector.ConnectorBase <DLL_BASENAME> -configfile <APP_CONFIGFILE>

Type: String

Default: None

Required: Yes


Connector

Example: JavaClassPath=JavaConnector.jar;WorkSiteConnector.jar; wscrawler.jar;log4j-1.2.15.jar;commons-dbcp-1.2.2.jar; commons-pool-1.3.jar;sqljdbc.jar

See Also: “JavaConnectorClass” on page 56


• • • •••


56

JavaConnectorClass

Specify the full class name of the Java class that contains the implementation of the connector. For WorkSite Connector, this is com/autonomy/connector/WorkSite/WorkSiteConnector.

JavaMaxMemoryMB

Specify the maximum memory (in megabytes) that can be allocated to the Java Virtual Machine (JVM).

Type: String

Default: None

Required: Yes


Connector

Example: javaConnectorClass=com/autonomy/connector/WorkSite/WorkSiteConnector

See Also: “JavaClassPath” on page 55

Type: Integer

Default: 64

Required: No


Connector

Example: JavaMaxMemoryMB=64

See Also: “JavaConnectorClass” on page 56


• • • •••


ScheduleCycles

Specify the number of fetching cycles to run. If you set the parameter to 5, for example, the connector will complete five cylces and then wait until it is sent a manual command. If this value is set to -1, the connector runs continually.

ScheduleRepeatSecs

Specify how frequently after the ScheduleStartTime the synchronize action will run.

Type: Integer

Default: -1

Required: No.


Connector, FetchTasks, and TaskName

Example: ScheduleCycles=-1

See Also:

Type: Integer

Default: 300

Required: No.



Example: ScheduleRepeatSecs=300

See Also: “ScheduleStartTime” on page 58


• • • •••


58

ScheduleStartTime

Specify the starting time of the first synchronize task on startup. This parameters requires that the EnableScheduledTasks parameter be set to true. The format for this parameter value is:

‘H[H][:MM][:SS]’;

TempDirectory

Specify the temporary directory for the connector to use.

Type: Time

Default: NOW

Required: No.



Example: ScheduleStartTime=’08:30:00’;

See Also: “EnableScheduledTasks” on page 54“ScheduleRepeatSecs” on page 57

Type: String

Default: ./Temp

Required: No


Connector

Example: TempDirectory=./Temp

See Also: “SharedPath” on page 60


• • • •••



The parameters in this section specify details for the Connector Framework server (also known as the Ingestion server). The server accepts data from the connector, generates an IDX or XML file, and sends the file to IDOL for indexing.

BatchSize

Specify the maximum number of add, update, or remove actions included in batch that is sent to the Connector Framework server.

Host

Specify the host name or IP address of the Connector Framework server through which the data is sent.

Type: Integer

Default: 100

Required: No

Allowed Range:


Recommended Range:



Ingestion

Example: BatchSize=100

See Also:

Type: String

Default: localhost

Required: Yes


Ingestion

Example: Host=localhost,127.0.0.1

See Also: “Port” on page 60


• • • •••


60

IndexDatabase

Specify the IDOL database in which documents will be indexed. If this is set, the DREDBNAME field is set to this value.

Port

Specify the port number of the Connector Framework server through which the data is sent.

SharedPath

Specify a path common to both the connector and the Connector Framework server to temporarily hold files for ingestion. If this parameter is not specified, it is assumed that the TempDirectory is accessible by both servers.

Type: String

Default: None

Required: No


Ingestion and TaskName

Example: IndexDatabase=Myindexdatabase1

See Also:

Type: Integer

Default: 7000

Required: Yes


Ingestion

Example: Port=7000

See Also: “Host” on page 59

Type: String

Default: None

Required: No


• • • •••



These sections define the URL and accounts from which you want to retrieve data. In the [FetchTasks] section, you enter the total number of tasks in the Number parameter and then list the tasks in consecutive order starting from 0 (zero). You then create a TaskName section for each task listed. For example:

[FetchTasks]Number=10=MyTask1

[MyTask1]DatabaseHost=dbhostDatabasePort=1433DatabaseName=mydbDatabaseUsername=userDatabasePassword=password...

AllVersions

Specify whether all versions of a document are indexed or only the highest version number.


Ingestion

Example: SharedPath=./<path name>

See Also: “TempDirectory” on page 58

Type: Boolean

Default: true

Required: No


FetchTasks and TaskName

Example: AllVersions=True

See Also:


• • • •••


62

DatabaseHost

Specify the name of the computer hosting the database.

DatabaseInstanceName

If the DBMS is not the default instance, specify the database instance name.

DatabaseIntegratedAuth

Specify whether Microsoft Integrated Authentication is used to access the database.

Type: String

Default: None

Required: Yes



Example: DatabaseHost=ComputerName

See Also: “DatabasePort” on page 64

Type: String

Default: None

Required: No



Example: DatabaseInstanceName=DBInstanceName

See Also:

Type: Boolean

Default: false

Required: No


• • • •••


DatabaseName

Specify the name of the database that houses the library.

DatabasePassword

Specify the password for the username that is used to authenticate to the WorkSite database. This password must be encrypted.



Example: DatabaseIntegratedAuth=false

See Also:

Type: String

Default: None

Required: No



Example: DatabaseName=DatabaseName

See Also:

Type: String

Default: None

Required: Yes



Example: DatabasePassword=XYZ1234A

See Also: “DatabaseUserName” on page 64


• • • •••


64

DatabasePort

Specify the port number of the database server.

DatabaseUserName

Specify the username that is used to authenticate to the WorkSite database.

DatabaseVendor

Specify the database vendor. The options are Oracle or SqlServer.

Type: Integer

Default: 1433

Required: Yes



Example: DatabasePort=1433

See Also: “DatabaseHost” on page 62

Type: String

Default: None

Required: Yes



Example: DatabaseUserName=J0hnD038

See Also: “DatabasePassword” on page 63

Type: String

Default: None

Required: No


• • • •••


DefaultDateRange

If this parameter is enabled, the time of the last synchronize action is stored to file and only updates after that time are processed. Otherwise, the files processed are controlled by the dynamic parameters or others above.

DynamicParameterNameN

Specify the names of additional parameters to be used by the crawler.



Example: DatabaseVendor=SqlServer

See Also:

Type: Boolean

Default: true

Required: No



Example: DefaultDateRange=True

See Also:

Type: String

Default: None

Required: No



Example: DynamicParameterName0=numberOfRecordsToReturn

See Also: “DynamicParameterValueN” on page 66


• • • •••


66

DynamicParameterValueN

Specify the values of additional parameters to be used by the crawler.

FirstDocument

Specify the first document number to process.

LastDocument

Specify the last document number to process.

Type: String

Default: None

Required: No



Example: DynamicParameterValue0=100

See Also: “DynamicParameterNameN” on page 65

Type: Integer

Default: None

Required: No



Example: FirstDocument=127

See Also: “LastDocument” on page 66

Type: Integer

Default: None

Required: No


• • • •••


MappedSecurity

Specify whether document Access Control Lists (ACLs) are extracted to the AUTONOMYMETADATA field.

MaxDocuments

Specify the maximum number of documents to process.



Example: LastDocument=1754

See Also: “FirstDocument” on page 66

Type: Boolean

Default: true

Required: No



Example: MappedSecurity=true

See Also: “SecurityType” on page 69

Type: Integer

Default: None

Required: No



Example: MaxDocuments=17540

See Also: “FirstDocument” on page 66“LastDocument” on page 66


• • • •••


68

N

This parameter indicates the name of a task and specifies the name of the section containing the parameters that apply to a task, where:

N. The number of the task. Note that the numbering must start from zero (0).

TaskName. The name of the task. For each task that you list, you must define a [TaskName] section.

Number

Specify the number of tasks listed in the configuration.

Type: String

Default: None

Required: Yes


Connector and FetchTasks

Example: 0=MyFirstTask1=MySecondTask

In this example, two tasks are defined: MyFirstTask and MySecondTask. You must create a section for each job, called [MyFirstTask] and [MySecondTask], in which you can then specify the parameters that apply to these tasks.

See Also: “Number” on page 68

Type: Integer

Default: 0

Required: No


Connector and FetchTasks

Example: Number=20=MyFirstTask1=MySecondTask

See Also: “N” on page 68


• • • •••


SecurityType

Specify the SECURITYTYPE field if the MappedSecurity parameter is enabled.

WorksiteLibrary

Specify the WorkSite library name. This is prepended to the reference.

Type: String

Default: WORKSITE

Required: No



Example: SecurityType=WORKSITE

See Also: “MappedSecurity” on page 67

Type: String

Default:

Required: No



Example: WorksiteLibary=LibraryName

See Also:


• • • •••


70
• • • •••

CHAPTER 5 Connector Framework Server ParametersThis chapter describes the Connector Framework server (CFS) configuration parameters. It contains the following sections:

Service Parameters

Server Parameters

Actions Parameters



Indexing Parameters

Connector Framework server supports standard service parameters, logging parameters and log streams. For more information, see the IDOL Server Administration Guide. This section lists the Connector Framework server configuration parameters.


• • • •••

Chapter 5 Connector Framework Server Parameters

72

Service Parameters

The parameters in this section determine which machines are permitted to use and control the Connector Framework service.

Related Topics


Server Parameters

The parameters in this section specify details for the Connector Framework server.

AdminClients

Specify the IP addresses or names of clients that can issue administrative commands to the ACI Port.



Type: String

Default: *.*.*.*

Required: No


Server

Example: AdminClients=localhost,196.172.87.11

See Also: “Port” on page 73 “QueryClients” on page 73


• • • •••

Server Parameters

Port

Specify the ACI port by which actions are sent to the Connector Framework server.

QueryClients

Specify the IP addresses or names of clients that can query the connector.



Type: Long

Default: 7000

Required: No

Allowed Range:


Recommended Range:



Server

Example: Port=7008

See Also:

Type: String

Default: *.*.*.*

Required: No


Server

Example: QueryClients=10.1.1..*,127.0.0.1

See Also: “Port” on page 73 “AdminClients” on page 72


• • • •••


74

Actions Parameters

The parameters in this section control how actions are sent Connector Framework server.

MaximumThreads

Specify the number of actions that the CFS can process in parallel at any one time. The optimal value for this parameter is dependant on the load of the server. The default is generally sufficient for most loads.


The parameters in this section control how documents are imported to IDX or XML before they are indexed into IDOL server.

PostN

Identify a task to call after documents are imported but before they are indexed into IDOL server. Tasks must be numbered starting from zero (0). You can specify a Lua script or the IDX Writer. The IDX Writer is included in the Connector Framework server and generates an IDX file.

You must specify the task using the following format:

PostN=TaskType:Path_to_Script or MyTaskSection

where TaskType could be Lua to specify a Lua script, or IdxWriter to specify the CFS IDX Writer.

Parameters that should be passed to the task can be specified in a corresponding configuration section. This is optional. For example:

Type: Integer

Default: 2

Required No


actions

Example: MaximumThreads=10


• • • •••


Post0=IdxWriter:IdxWriting[IdxWriting]IdxWriterFilename=Job0.idxIdxWriterMaxSizeKBs=100IdxWriterArchiveDirectory=./IDXArchive

In this example, the Post0 task creates a backup IDX file (Job0.idx) in the IDXArchive directory using the IDX Writer.

PreN

Identify a task to call before documents are imported and indexed into IDOL server. Tasks must be numbered starting from zero (0). You can specify a Lua script or the IDX Writer. The IDX Writer is included in the Connector Framework server and generates an IDX file.

You must specify the task using the following format:

PreN=TaskType:Path_to_Script or MyTaskSection

where TaskType could be Lua to specify a Lua script, or IdxWriter to specify the CFS IDX Writer.

Parameters that should be passed to the task can be specified in a corresponding configuration section. This is optional. For example:

Post0=IdxWriter:IdxWriting[IdxWriting]IdxWriterFilename=Job0.idxIdxWriterMaxSizeKBs=100IdxWriterArchiveDirectory=./IDXArchive

In this example, the Pre0 task creates a backup IDX file (Job0.idx) in the IDXArchive directory using the IDX Writer.

Type: String

Default: None

Required No


ImportTasks

Example: Post0=Lua:C:\Scripts\posttask1.lua

See Also: “PreN” on page 75“HashLua” on page 76


• • • •••


76

HashLua

Specify a file containing a Lua script to use for family hashing. The script inserts an MD5 field into the document, which is a hash of the document’s unique fields.

ImportStatisticsFile

Specify an XML file that contains records of the job file size and document counts.

Type: String

Default: None

Required: No


ImportTasks

Example: Pre0=C:\Scripts\pretask1.lua

See Also “PostN” on page 74“HashLua” on page 76

Type: String

Default: None

Required: No


ImportTasks

Example: HashLua=hash.lua

See Also “ImportHashFamilies” on page 78“ImportFamilyRootExcludeFmtCSV” on page 77

Type: String

Default: None

Required No


ImportTasks

Example: ImportStatisticsFile=stats.xml


• • • •••



The parameters in this section specify details for KeyView and the service that imports documents into IDX or XML.

ExtractDirectory

Specify the directory to which to files are extracted. Use this parameter only when you want to keep copies of all extracted files.

ImportFamilyRootExcludeFmtCSV

Specify which KeyView formats not to designate as family roots if family hashing is enabled. For example, if you exclude the PST format (KeyView value 356), when Import Module Advanced hashes a PST file, it does not consider PST container as the root format. Instead, it searches for a deeper format that is not listed as a CSV: in this case, it would find the MAIL format, which would then be considered the root of the family.

For a complete list of KeyView formats, see “KeyView Format Codes” on page 137.

Type: String

Default: Current directory

Required No


ImportService

Example: ExtractDirectory=C:\temp

Type: String

Default: false

Required No


• • • •••


78

ImportHashFamilies

Specify whether to enable family hashing, which is used for de-duplication.

ImportInheritFieldsCSV

Specify a comma-separated list of fields that should be inherited from parent files by their children. For example, if you specify SUBJECT in this parameter, all the child attachments in a parent MSG file will contain a Subject field.


ImportService

Example: ImportFamilyRootExcludeFmtCSV=356,157,233,345

In this example, the numeric values correspond to the following formats:

356=PST157=ZIP233=EML345=MSG

See Also: “HashLua” on page 76“ImportHashFamilies” on page 78

Type: Boolean

Default: false

Required No


ImportService

Example: ImportHashFamilies=true

See Also: “HashLua” on page 76“ImportFamilyRootExcludeFmtCSV” on page 77“ImportMergeMails” on page 79

Type: String

Default: None

Required No


• • • •••


ImportMergeMails

Specify whether to merge the two files created by KeyView (the empty MSG or EML container file, and the MAIL file that contains the actual message content) when importing MSG or EML files. Set this to true to merge the two files.

KeyviewDirectory

Specify the location of the KeyView filters that Connector Framework Server uses to process documents. Enter the full path to the filters directory. By default, this is C:\Autonomy\ConnectorFramework\filters\.


ImportService

Example: ImportInheritFieldsCSV=AUTN_IDENTIFIER

See Also:

Type: Boolean

Default: false

Required No. Recommended if ImportHashFamilies=true.


ImportService

Example: ImportMergeMails=true

See Also: “ImportHashFamilies” on page 78

Type: String

Default: None

Required Yes


ImportService

Example: KeyviewDirectory=C:\Autonomy\ConnectorFramework\filters\


• • • •••


80

RevisionMarks

Specify whether revision mark information (such as deleted text) is extracted from Microsoft Word documents. If Microsoft Word’s revision tracking feature was enabled when changes were made to a document, the CFS can extract the tracked information and include it in the index. Set to true to extract revision mark information.

ThreadCount

Specify the number of threads to run. This parameter is only used for importing.

Type: Boolean

Default: false

Required No


ImportService

Example: RevisionMarks=true

Type: Integer

Default: 4

Required No


ImportService

Example: ThreadCount=3


• • • •••

Indexing Parameters

Indexing Parameters

The parameters in this section specify the details for the IDOL server(s) to which the Connector Framework server will send documents for indexing.

DREHostN

Specify the IP address or host name of each IDOL server with which Connector Framework server communicates. There must be a corresponding DREACIPortN entry.

ErrorTaskN

Identify a task to call when an error occurs. For example, documents with errors can be written to a directory or a Lua script can be called. The task must be specified in a corresponding configuration section.

Type: String

Default: None

Required At least one entry is required.


Indexing

Example: DREHost0=hostmachine0

See Also:

Type: String

Default: None

Required No


Indexing

Example: ErrorTask0=IdxWriter:IdxErrorWriting

[IdxErrorWriting]IdxWriterFilename=Error.idxIdxWriterMaxSizeKBs=100IdxWriterArchiveDirectory=./ErrorArchive

In this example, ErrorTask0 writes errors to the Error.idx file using the IdxWriter class (included with CFS).


• • • •••


82

IndexBatchSize

Specify the maximum number of files that are included each batch that is indexed into IDOL server.

IndexTimeInterval

Specify the timeout value in seconds for the index queue. If no documents were indexed in the specified interval, any documents in the queue (up to the number specified in IndexBatchSize) are indexed.

Type: Integer

Default: 100

Required No


Indexing

Example: IndexBatchSize=100

Type: Integer

Default: 300

Required No


Indexing

Example: IndexTimeInterval=100

See Also: “IndexBatchSize” on page 82


• • • •••

CHAPTER 6 License Parameters This chapter describes the license configuration parameters that specify licensing details.

Full

Holder

Key

LicenseServerACIPort

LicenseServerHost

LicenseServerTimeout

LicenseServerRetries

Operation

NOTE Do not edit these parameters.


• • • •••

Chapter 6 License Parameters

84

Full

Indicates whether you have a full or an evaluation license.

Holder

The name of the license holder.

Key

The license key.

Type: Boolean

Default: False

Required: Yes


License

Example: Full=on

In this example, the service is fully licensed.

Type: String

Default: None

Required: Yes


License

Example: Holder=Company

Type: String

Default: None


• • • •••



ACI port of DiSH license server. This must be the Port specified in the DiSH configuration file's [Server] section. Worksite Connector uses this port to request licensing from DiSH. This parameter is used in IDOL with Administration.

Required: Yes


License

Example: Key=01234567890

Type: Long

Default: 20000

Required: Yes

Allowed range: Minimum: 0Maximum: 65536

Recommended range:



License

Example: LicenseServerACIPort=20000

See Also: “LicenseServerHost” on page 86“LicenseServerTimeout” on page 86“LicenseServerRetries” on page 87


• • • •••


86

LicenseServerHost

Address of DiSH host. The IP address (or name) of the machine that hosts the DiSH license server. This parameter is used in IDOL with Administration.

LicenseServerTimeout

Seconds to timeout when Worksite 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 does not respond. This parameter is used in IDOL with Administration.

Type: String

Default: None

Required: Yes


License

Example: LicenseServerHost=1.23.45.6

See Also: “LicenseServerACIPort” on page 85“LicenseServerTimeout” on page 86“LicenseServerRetries” on page 87

Type: Long

Default: 120000

Required: No


License

Example: LicenseServerTimeout=600000

See Also: “LicenseServerACIPort” on page 85“LicenseServerHost” on page 86“LicenseServerRetries” on page 87


• • • •••



Number of retries when Worksite Connector connects to DiSH. The number of times Worksite Connector tries to connect to the DiSH license server. This parameter is used in IDOL with Administration.

Operation

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

Type: Integer

Default: 5

Required: No


License

Example: LicenseServerRetries=1

See Also: “LicenseServerACIPort” on page 85“LicenseServerHost” on page 86“LicenseServerTimeout” on page 86

Type: String

Default: None

Required: Yes


License

Example: Operations=803|87sdhsdf9n94nmsf7oasda987w4yriasunfaasd==


• • • •••


88
• • • •••

CHAPTER 7 Logging ParametersThis 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.

LogArchiveDirectory

LogCompressionMode

LogDirectory

LogEcho

LogEncryption

LogEncryptionKeys

LogExpireAction

LogFile

LogHistorySize

LogLevel

LogLevelMatch

LogMaxLineLength

LogMaxOldFiles

LogMaxSizeKBs

LogOldAction


• • • •••

Chapter 7 Logging Parameters

90

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: String

Default: ./archive

Required: No


Logging and/or LogStream

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

Example: LogArchiveDirectory=./archive

See Also: “LogOldAction” on page 100


• • • •••

LogCompressionMode

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: String

Default: zip

Required: No




Example: LogCompressionMode=gz

See Also: “LogExpireAction” on page 94

Type: String

Default: ./logs

Required: No


Logging

Example: LogDirectory=./logs

See Also: “LogArchiveDirectory” on page 90“LogFile” on page 95


• • • •••


92

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.

Type: Boolean

Default: False

Required: No




Example: LogEcho=true

See Also: “LogArchiveDirectory” on page 90


• • • •••

LogEncryption

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.

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.

Type: Boolean

Default: False

Required: No




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 93

Type: String

Default: None

Required: Yes, if you have set LogEncryption to true.


• • • •••


94

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:


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 93

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. Log files are archived once they reach the LogMaxSizeKBs size.

Note: The LogMaxSizeKBs parameter takes precedence over the LogExpireAction parameter. Therefore, if you set LogExpireAction to Day, and the value for LogMaxSizeKBs results in more than one log file, multiple log files will be generated per day.


• • • •••

LogFile

LogFile

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

Type: String

Default: Datestamp

Required: No




Example: LogExpireAction=Compress

See Also: “LogCompressionMode” on page 91“LogFile” on page 95“LogMaxSizeKBs” on page 100

Type: String

Default: None

Required: Yes




Example: LogFile=query.log

See Also: “LogDirectory” on page 91


• • • •••


96

LogHistorySize

The number of log messages to store in memory.

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.

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

Type: String

Default: 100

Required: Yes

Allowed Range:



LogStream

Example: LogHistorySize=50


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.


• • • •••

LogLevelMatch

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: String

Default: Normal

Required: No




Example: LogLevel=Warning

See Also: “LogFile” on page 95“LogLevelMatch” on page 97

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.


• • • •••


98

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: String

Default: GreaterThanOrEqual

Required: No




Example: LogLevelMatch=GreaterThanOrEqual

See Also: “LogFile” on page 95“LogLevel” on page 96“LogOutputLogLevel” on page 101

Option Description

Type: Long

Default: 16384

Required: No


• • • •••

LogMaxOldFiles

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.

Allowed Range:


Recommended Range:





Example: LogMaxLineLength=24000

See Also: “LogFile” on page 95

Type: Long

Default: 1024

Required: No




Example: LogMaxOldFiles=1000

See Also: “LogDirectory” on page 91“LogOldAction” on page 100


• • • •••


10

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:

Type: Long

Default: 1024

Required: No




Example: LogMaxSizeKBs=1000


Option Description

Delete The log files are deleted.

Move The log files are moved to the specified LogArchiveDirectory.

Type: String

Default: Delete

Required: No


• • • •••

LogOutputLogLevel

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 90“LogDirectory” on page 91“LogMaxOldFiles” on page 99

Type: Boolean

Default: False

Required: No




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 96


• • • •••


10

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.

Type: Boolean

Default: False

Required: No




Example: LogSysLog=true

Type: Boolean

Default: True

Required: No




Example: LogTime=false



• • • •••

LogTypeCSVs

LogTypeCSVs

List of message types to log. Enter one or more of the following message types to specify the type of messages written to the associated log file. If you want to enter multiple message types, separate them with commas (there must be no space before or after a comma):

Option Description

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)


• • • •••


10

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)

Type: String

Default: None

Required: Yes


LogStream

Example: LogTypeCSVs=Application,Index


Option Description


• • • •••

CHAPTER 8 Secure Socket Layer ParametersThis chapter describes the configuration parameters used to configure Secure Socket Layer (SSL) connections between components.

SSLConfig

SSLCACertificate

SSLCertificate

SSLCheckCertificate

SSLCheckCommonName

SSLMethod

SSLPrivateKey

SSLPrivateKeyPassword


• • • •••

Chapter 8 Secure Socket Layer Parameters

10

SSLConfig

Identifies the configuration section in which the SSL configuration details are specified, usually SSLOptionN. You must set this parameter if you are using SSL connections between components.

To control incoming ACI calls, set this parameter in the [Server] or [Default] section.

To control outgoing ACI calls, set this parameter in another component section, such as [DataDRE], [CatDRE], or a connector Job section.

The section in which you set SSLConfig depends on whether you are using a distributed architecture and on which component you are configuring. For example, in a standalone Category configuration, you can set SSLConfig in the [Server], [DataDRE], [CatDRE], and [CommunityServer] sections.

See each component’s documentation for more information.

Type: String

Default: None

Required: No


• • • •••

SSLConfig


Server or Default, or other section for outgoing communications

Example: [Server]SSLConfig=SSLOptions1...

[AgentDRE]SSLConfig=SSLOptions2...

[DataDRE]SSLConfig=SSLOptions2...

// For Omni Group Servers:

[Note]GroupServerHost=...GroupServerPort=...SSLConfig=SSLOptions2

[SSLOptions1] //SSL options for incoming connectionsSSLMethod=SSLV23SSLCertificate=host1.crtSSLPrivateKey=host1.keySSLCACertificate=trusted.crt

[SSLOptions2] //SSL options for outgoing connectionsSSLMethod= SSLV23SSLCertificate=host2.crtSSLPrivateKey=9s7BxMjD2d3M3t7awt/J8ASSLCACertificate=trusted.crt

See Also: “SSLCACertificate” on page 108“SSLCertificate” on page 108“SSLCheckCertificate” on page 109“SSLCheckCommonName” on page 109“SSLMethod” on page 110“SSLPrivateKey” on page 110“SSLPrivateKeyPassword” on page 111


• • • •••


10

SSLCACertificate

Certificate Authority (CA) certificate file of a trusted authority. The component will only trust communication with a peer that provides a certificate signed by the specified CAs.

SSLCertificate

SSL Certificate file to use to identify this component to a peer. It can be either ASN1 or PEM format. This parameter requires a matching SSLPrivateKey value.

Type: String

Default: None

Required: No


SSLOptionN

Example: SSLCACertificate=trusted.crt

See Also: “SSLConfig” on page 106

Type: String

Default: None

Required: Yes


SSLOptionN

Example: SSLCertificate=host1.crtSSLPrivateKey=host1.key

See Also: “SSLConfig” on page 106“SSLPrivateKey” on page 110


• • • •••

SSLCheckCertificate

SSLCheckCertificate

Specifies whether a certificate signed by a trusted authority is requested from peers.

Setting SSLCACertificate implicitly sets SSLCheckCertificate to true. If SSLCACertificate is set to false, communications are encrypted, but certificates are not requested from peers.

SSLCheckCommonName

Verifies the identity of the peer. Specifies whether the host name listed in the peer's certificate (that is, the CommonName or "CN" attribute) resolves to the same IP address as the peer itself, as determined by the network connection.

For example, if the host name in a certificate is eip.autonomy.com and resolves to an IP address of 12.3.4.56, then the peer should share the same IP address.

Type: Boolean

Default: True if SSLCACertificate is set.

False if SSLCACertificate is not set.

Required: No


SSLOptionN

Example: SSLCheckCertificate=true


Type: Boolean

Default: False

Required: No


SSLOptionN

Example: SSLCheckCommonName=true



• • • •••


11

SSLMethod

Specifies which SSL protocol is used. The options are:

SSLV2

SSLV3

SSLV23

TLSV1

SSLV23 should be used in most cases.

SSLPrivateKey

The private security key for the SSL certificate. It can be either ASN1 or PEM format. This parameter requires a matching SSLCertificate value.

Type: String

Default: None

Required: Yes


SSLOptionN

Example: SSLMethod=SSLV23


Type: String

Default: None

Required: Yes


SSLOptionN

Example: SSLCertificate=host1.crtSSLPrivateKey=host1.key

See Also: “SSLConfig” on page 106“SSLCertificate” on page 108“SSLPrivateKeyPassword” on page 111


• • • •••



The password for the file defined in SSLPrivateKey. The password may be in plain text, or basic or AES encryption format.

Type: String

Default: None

Required: No


SSLOptionN

Example: [SSLOption0]SSLCertificate=host1.crtSSLPrivateKey=host1.keySSLPrivateKeyPassword=PvKey1559

In this example, the private key password to the file host1.key is written in plain text.

...[SSLOption0]SSLCertificate=host1.crtSSLPrivateKey=host1.keySSLPrivateKeyPassword=9s7BxMjD2d3M3t7awt/J8A

In this example, the private key password to the file host1.key has basic encryption.

See Also: “SSLConfig” on page 106“SSLPrivateKey” on page 110


• • • •••


11
• • • •••

CHAPTER 9 Service ActionsIf the ServicePort, ServiceStatusClients and ServiceControlClients configuration parameters are specified, the service port is enabled and will accept the status and control actions described in this section.

Action Syntax

GetConfig

GetLogStream

GetLogStreamNames

GetStatistics

GetStatus

GetStatusInfo

MergeConfig

SetConfig

Stop


• • • •••

Chapter 9 Service Actions

11

Action Syntax

The actions use the following format:

http://Host:Port/action=ActionName&[Parameters]

where,

For example:

http://12.3.4.56:40010/action=GetConfig

This command uses port 40010 to request the service’s configuration file settings.

Related Topics

“Service Action Parameters” on page 125

GetConfig

The GetConfig action returns the service’s configuration file settings. (This parameter is not supported by the Sharepoint connector.)

Action Parameters

None.

Example

action=GetConfig

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 actions described in this section.

Parameters One or more parameters that may be required by an action.


• • • •••

GetLogStream

GetLogStream

The GetLogStream action returns a specific log stream for the service. (This parameter is not supported by the Sharepoint Connector.)

Action Parameters

The action has the following optional parameters:

Example

action=GetLogStream&Name=ApplicationLogStream&FromDisk=true&Tail=10

This action displays the first ten entries of the ApplicationLogStream log.

GetLogStreamNames

The GetLogStreamNames action returns the names of the log streams defined for the service. (This parameter is not supported by the Sharepoint Connector.)

Action Parameters

None.

Example

action=GetLogStreamNames

Parameter Description

FromDisk Specifies whether the log stream is read from disk or memory.

Name The name of the log stream you want to return.

Tail The number of lines from the log stream to return.


• • • •••


11

GetStatistics

The GetStatistics action returns statistics for the service. (This parameter is not supported by the Sharepoint Connector.)

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.


• • • •••

GetStatistics

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.



• • • •••


11

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.

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



• • • •••

GetStatus

Action Parameters

None.

Example

action=GetStatistics

GetStatus

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

Action Parameters

None.

Example

action=GetStatus

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.



• • • •••


12

GetStatusInfo

The GetStatusInfo action returns status information for the service (for example, the service’s product name, version number and so on). (This parameter is not supported by the Sharepoint Connector.)

The following status information for the service are returned:

NOTE In the Sharepoint connector, the action must be preceded by a question mark (?). For example, ?action=GetStatus.

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


• • • •••

MergeConfig

Action Parameters

None.

Example

action=GetStatusInfo

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

set an individual configuration parameter (using the KeyN and ValueN parameters).

(This parameter is not supported by the Sharepoint Connector.)

Action Parameters

The action has the following parameters:

Example

action=MergeConfig&DeleteKey0=Default/DREFieldName


Config The configuration file content you want to merge with the content of the service's configuration file.

DeleteKeyN The configuration file section containing the parameter you want to delete and the name of the parameter.

KeyN The configuration file section containing the parameter you want to set and the name of the parameter.

ValueN The value you want to set for the corresponding parameter.


• • • •••


12

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

SetConfig

The SetConfig command allows you to set the service’s configuration file. (This parameter is not supported by the Sharepoint Connector.)

Action Parameters

The action has the following parameters:

Example

action=SetConfig&Config=ConfigFileContent

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

Stop

The Stop command stops the service.

Action Parameters

None.

NOTE This command requires a POST request method. See the IDOL Server Administration Guide for more information on using a POST request method.


Config The configuration file content with which you want to overwrite the current content of the service's configuration file.


• • • •••

Stop

Example

action=Stop

NOTE In the Sharepoint connector, the action must be preceded by a question mark (?). For example, ?action=Stop.


• • • •••


12
• • • •••

CHAPTER 10 Service Action ParametersThis chapter describes the parameters that can be used with Service actions:

Config

DeleteKeyN

FromDisk

Name

Tail

KeyN

ValueN

Config

Enter the configuration file content with which you want to merge or overwrite the current content of the service's configuration file.

If the service's configuration file contains a section with the same name as the section with which it is going to be merged, any parameters unique to the new section are added to the existing section. If the new section contains parameters already present in the existing section, the new section's parameters overwrite the parameters of the old section.


• • • •••

Chapter 10 Service Action Parameters

12

DeleteKeyN

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 DeleteKeyN you specify. You must specify the section and parameter using the format configFileSection/parameterName.

NOTE This requires a POST request method. See the IDOL Server Administration Guide for information on using a POST request method.

Action MergeConfigSetConfig

Type: String

Default: None

Required: Yes (if DeleteKeyN or KeyN parameter is not specified)

Example: 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.

See Also: “DeleteKeyN” on page 126“KeyN” on page 128

Action MergeConfig

Type: String

Default: None

Required: No

Example: 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.


• • • •••

FromDisk

FromDisk

Specifies whether the log stream is read from disk or memory. Enter true if you want the log stream to be read from disk rather than from memory.

Name

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

Tail

Enter the number of lines from the log stream to return. The lines are read from the top (that is the most recent lines are retuned). Enter -1 to return all entries.

Action GetLogStream

Type: Boolean

Default: false

Required: No

Example: action=GetLogStream&Name=ApplicationLogStream&FromDisk=true&Tail=10

Action GetLogStream

Type: String

Default: false

Required: Yes

Example: action=GetLogStream&Name=ApplicationLogStream&FromDisk=true&Tail=10

Action GetLogStream

Type: Long


• • • •••


12

KeyN

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 KeyN you specify, and use the same number for the corresponding ValueN parameter. You must specify the section and parameter using the format configFileSection/parameterName.

Default: -1

Required: No

Example: action=GetLogStream&Name=ApplicationLogStream&Tail=10

Action MergeConfig

Type: String

Default: None

Required: Yes (if DeleteKeyN or Config parameter not specified)

Example: action=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.

See Also: “ValueN” on page 129“DeleteKeyN” on page 126“Config” on page 125


• • • •••

ValueN

ValueN

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

Action MergeConfig

Type: String

Default: None

Required: Yes (if KeyN parameters is specified).

Example: 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.

See Also: “KeyN” on page 128


• • • •••


13
• • • •••

CHAPTER 11 Service Configuration ParametersThis chapter describes the Service configuration parameters that determine which machines are permitted to use and control a service.

If the ServicePort, ServiceStatusClients and ServiceControlClients configuration parameters are specified, the service port is enabled and will accept the standard status and control commands described in “Service Actions” on page 113.

ServiceACIMode

ServiceControlClients

ServiceHost

ServicePort

ServiceStatusClients


• • • •••

Chapter 11 Service Configuration Parameters

13

ServiceACIMode

Generate ACI-compatible XML. (The ServiceACIMode parameter is not available in Sharepoint connector.)

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


Type: Boolean

Default: False

Required: No


Service

Example: ServiceACIMode=false

See Also: “ServiceControlClients” on page 132“ServiceHost” on page 133“ServicePort” on page 133“ServiceStatusClients” on page 134

Type: String

Default: *.*.*.*

Required: Yes


Service

Example: ServiceControlClients=localhost,127.0.0.1

See Also: “ServiceACIMode” on page 132“ServiceHost” on page 133“ServicePort” on page 133“ServiceStatusClients” on page 134


• • • •••

ServiceHost

ServiceHost

The host server on which the service is running. (The ServiceACIMode parameter is not available in Sharepoint connector.)

ServicePort

The port on the host server on which the service listens for service status and control requests.

Type: String

Default: *.*.*.*

Required: Yes


Service

Example: ServiceHost=127.0.0.1

See Also: “ServiceACIMode” on page 132“ServiceControlClients” on page 132“ServicePort” on page 133“ServiceStatusClients” on page 134

Type: Long

Default: 40010

Required: Yes

Allowed Range:


Recommended Range:



Service

Example: ServicePort=40010

See Also: “ServiceACIMode” on page 132“ServiceControlClients” on page 132“ServiceHost” on page 133“ServiceStatusClients” on page 134


• • • •••

Chapter 11 Service Configuration Parameters

13

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.


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.

Type: String

Default: *.*.*.*

Required: Yes


Service

Example: ServiceStatusClients=localhost,127.0.0.1

See Also: “ServiceACIMode” on page 132“ServiceControlClients” on page 132“ServiceHost” on page 133“ServicePort” on page 133


• • • •••

Appendixes

This section includes the following appendixes:

KeyView Format Codes

Appendixes


• • • •••

APPENDIX A KeyView Format CodesThis chapter lists the KeyView format classes and codes used with Connector Framework server. It includes the following section:

KeyView Classes

KeyView Formats

Table 1 lists KeyView file classes. The numbers are reported in the DocumentClass field in IDX files generated by Import Module. Consult the table to determine the file class that was imported.

Table 2 lists all KeyView formats. The numbers are reported in the DocumentType field in IDX files generated by Import Module. Consult the table to determine the file type that was imported.

You can use any of the format numbers from Table 2 in conjunction with the ImportFamilyRootExcludeFmtCSV parameter. For more information, see “ImportFamilyRootExcludeFmtCSV” on page 77.


• • • •••

Appendix A KeyView Format Codes

13

KeyView Classes

Table 1 KeyView Classes

Attribute Number File Class

0 No file class

01 Word processor

02 Spreadsheet

03 Database

04 Raster image

05 Vector graphic

06 Presentation

07 Executable

08 Encapsulation

09 Sound

10 Desktop publishing

11 Outline/planning

12 Miscellaneous

13 Mixed format

14 Font

15 Time scheduling

16 Communications

17 Object module

18 Library module

19 Fax

20 Movie

21 Animation


• • • •••

KeyView Formats

KeyView Formats

Table 2 KeyView Formats

Format NameFormat Number Format Description

AES_Multiplus_Comm_Fmt 1 Multiplus (AES)

ASCII_Text_Fmt 2 Text

MSDOS_Batch_File_Fmt 3 MS-DOS Batch File

Applix_Alis_Fmt 4 APPLIX ASTERIX

BMP_Fmt 5 Windows Bitmap

CT_DEF_Fmt 6 Convergent Technologies DEF Comm. Format

Corel_Draw_Fmt 7 Corel Draw

CGM_ClearText_Fmt 8 Computer Graphics Metafile (CGM)

CGM_Binary_Fmt 9 Computer Graphics Metafile (CGM)

CGM_Character_Fmt 10 Computer Graphics Metafile (CGM)

Word_Connection_Fmt 11 Word Connection

COMET_TOP_Word_Fmt 12 COMET TOP

CEOwrite_Fmt 13 CEOwrite

DSA101_Fmt 14 DSA101 (Honeywell Bull)

DCA_RFT_Fmt 15 DCA-RFT (IBM Revisable Form)

CDA_DDIF_Fmt 16 CDA / DDIF

DG_CDS_Fmt 17 DG Common Data Stream (CDS)

Micrografx_Draw_Fmt 18 Windows Draw (Micrografx)

Data_Point_VistaWord_Fmt 19 Vistaword

DECdx_Fmt 20 DECdx

Enable_WP_Fmt 21 Enable Word Processing

EPSF_Fmt 22 Encapsulated PostScript

Preview_EPSF_Fmt 23 Encapsulated PostScript

MS_Executable_Fmt 24 MSDOS/Windows Program


• • • •••


14

G31D_Fmt 25 CCITT G3 1D

GIF_87a_Fmt 26 Graphics Interchange Format (GIF87a)

GIF_89a_Fmt 27 Graphics Interchange Format (GIF89a)

HP_Word_PC_Fmt 28 HP Word PC

IBM_1403_LinePrinter_Fmt 29 IBM 1403 Line Printer

IBM_DCF_Script_Fmt 30 DCF Script

IBM_DCA_FFT_Fmt 31 DCA-FFT (IBM Final Form)

Interleaf_Fmt 32 Interleaf

GEM_Image_Fmt 33 GEM Bit Image

IBM_Display_Write_Fmt 34 Display Write

Sun_Raster_Fmt 35 Sun Raster

Ami_Pro_Fmt 36 Lotus Ami Pro

Ami_Pro_StyleSheet_Fmt 37 Lotus Ami Pro Style Sheet

MORE_Fmt 38 MORE Database MAC

Lyrix_Fmt 39 Lyrix Word Processing

MASS_11_Fmt 40 MASS-11

MacPaint_Fmt 41 MacPaint

MS_Word_Mac_Fmt 42 Microsoft Word for Macintosh

SmartWare_II_Comm_Fmt 43 SmartWare II

MS_Word_Win_Fmt 44 Microsoft Word for Windows

Multimate_Fmt 45 MultiMate

Multimate_Fnote_Fmt 46 MultiMate Footnote File

Multimate_Adv_Fmt 47 MultiMate Advantage

Multimate_Adv_Fnote_Fmt 48 MultiMate Advantage Footnote File

Multimate_Adv_II_Fmt 49 MultiMate Advantage II

Multimate_Adv_II_Fnote_Fmt 50 MultiMate Advantage II Footnote File

Multiplan_PC_Fmt 51 Multiplan (PC)




• • • •••

KeyView Formats

Multiplan_Mac_Fmt 52 Multiplan (Mac)

MS_RTF_Fmt 53 Rich Text Format (RTF)

MS_Word_PC_Fmt 54 Microsoft Word for PC

MS_Word_PC_StyleSheet_Fmt 55 Microsoft Word for PC Style Sheet

MS_Word_PC_Glossary_Fmt 56 Microsoft Word for PC Glossary

MS_Word_PC_Driver_Fmt 57 Microsoft Word for PC Driver

MS_Word_PC_Misc_Fmt 58 Microsoft Word for PC Miscellaneous File

NBI_Async_Archive_Fmt 59 NBI Async Archive Format

Navy_DIF_Fmt 60 Navy DIF

NBI_Net_Archive_Fmt 61 NBI Net Archive Format

NIOS_TOP_Fmt 62 NIOS TOP

FileMaker_Mac_Fmt 63 Filemaker MAC

ODA_Q1_11_Fmt 64 ODA / ODIF

ODA_Q1_12_Fmt 65 ODA / ODIF

OLIDIF_Fmt 66 OLIDIF (Olivetti)

Office_Writer_Fmt 67 Office Writer

PC_Paintbrush_Fmt 68 PC Paintbrush Graphics (PCX)

CPT_Comm_Fmt 69 CPT

Lotus_PIC_Fmt 70 Lotus PIC

Mac_PICT_Fmt 71 QuickDraw Picture

Philips_Script_Word_Fmt 72 Philips Script

PostScript_Fmt 73 PostScript

PRIMEWORD_Fmt 74 PRIMEWORD

Quadratron_Q_One_v1_Fmt 75 Q-One V1.93J

Quadratron_Q_One_v2_Fmt 76 Q-One V2.0

SAMNA_Word_IV_Fmt 77 SAMNA Word

Ami_Pro_Draw_Fmt 78 Lotus Ami Pro Draw




• • • •••


14

SYLK_Spreadsheet_Fmt 79 SYLK

SmartWare_II_WP_Fmt 80 SmartWare II

Symphony_Fmt 81 Symphony

Targa_Fmt 82 Targa

TIFF_Fmt 83 TIFF

Targon_Word_Fmt 84 Targon Word

Uniplex_Ucalc_Fmt 85 Uniplex Ucalc

Uniplex_WP_Fmt 86 Uniplex

MS_Word_UNIX_Fmt 87 Microsoft Word UNIX

WANG_PC_Fmt 88 WANG PC

WordERA_Fmt 89 WordERA

WANG_WPS_Comm_Fmt 90 WANG WPS

WordPerfect_Mac_Fmt 91 WordPerfect MAC

WordPerfect_Fmt 92 WordPerfect

WordPerfect_VAX_Fmt 93 WordPerfect VAX

WordPerfect_Macro_Fmt 94 WordPerfect Macro

WordPerfect_Dictionary_Fmt 95 WordPerfect Spelling Dictionary

WordPerfect_Thesaurus_Fmt 96 WordPerfect Thesaurus

WordPerfect_Resource_Fmt 97 WordPerfect Resource File

WordPerfect_Driver_Fmt 98 WordPerfect Driver

WordPerfect_Cfg_Fmt 99 WordPerfect Configuration File

WordPerfect_Hyphenation_Fmt 100 WordPerfect Hyphenation Dictionary

WordPerfect_Misc_Fmt 101 WordPerfect Miscellaneous File

WordMARC_Fmt 102 WordMARC

Windows_Metafile_Fmt 103 Windows Metafile

Windows_Metafile_NoHdr_Fmt 104 Windows Metafile (no header)

SmartWare_II_DB_Fmt 105 SmartWare II




• • • •••

KeyView Formats

WordPerfect_Graphics_Fmt 106 WordPerfect Graphics

WordStar_Fmt 107 WordStar

WANG_WITA_Fmt 108 WANG WITA

Xerox_860_Comm_Fmt 109 Xerox 860

Xerox_Writer_Fmt 110 Xerox Writer

DIF_SpreadSheet_Fmt 111 Data Interchange Format (DIF)

Enable_Spreadsheet_Fmt 112 Enable Spreadsheet

SuperCalc_Fmt 113 Supercalc

UltraCalc_Fmt 114 UltraCalc

SmartWare_II_SS_Fmt 115 SmartWare II

SOF_Encapsulation_Fmt 116 Serialized Object Format (SOF)

PowerPoint_Win_Fmt 117 PowerPoint PC

PowerPoint_Mac_Fmt 118 PowerPoint MAC

PowerPoint_95_Fmt 119 PowerPoint 95

PowerPoint_97_Fmt 120 PowerPoint 97

PageMaker_Mac_Fmt 121 PageMaker for Macintosh

PageMaker_Win_Fmt 122 PageMaker for Windows

MS_Works_Mac_WP_Fmt 123 Microsoft Works for MAC

MS_Works_Mac_DB_Fmt 124 Microsoft Works for MAC

MS_Works_Mac_SS_Fmt 125 Microsoft Works for MAC

MS_Works_Mac_Comm_Fmt 126 Microsoft Works for MAC

MS_Works_DOS_WP_Fmt 127 Microsoft Works for DOS

MS_Works_DOS_DB_Fmt 128 Microsoft Works for DOS

MS_Works_DOS_SS_Fmt 129 Microsoft Works for DOS

MS_Works_Win_WP_Fmt 130 Microsoft Works for Windows

MS_Works_Win_DB_Fmt 131 Microsoft Works for Windows

MS_Works_Win_SS_Fmt 132 Microsoft Works for Windows




• • • •••


14

PC_Library_Fmt 133 DOS/Windows Object Library

MacWrite_Fmt 134 MacWrite

MacWrite_II_Fmt 135 MacWrite II

Freehand_Fmt 136 Freehand MAC

Disk_Doubler_Fmt 137 Disk Doubler

HP_GL_Fmt 138 HP Graphics Language

FrameMaker_Fmt 139 FrameMaker

FrameMaker_Book_Fmt 140 FrameMaker

Maker_Markup_Language_Fmt 141 Maker Markup Language

Maker_Interchange_Fmt 142 Maker Interchange Format (MIF)

JPEG_File_Interchange_Fmt 143 Interchange Format

Reflex_Fmt 144 Reflex

Framework_Fmt 145 Framework

Framework_II_Fmt 146 Framework II

Paradox_Fmt 147 Paradox

MS_Windows_Write_Fmt 148 Windows Write

Quattro_Pro_DOS_Fmt 149 Quattro Pro for DOS

Quattro_Pro_Win_Fmt 150 Quattro Pro for Windows

Persuasion_Fmt 151 Persuasion

Windows_Icon_Fmt 152 Windows Icon Format

Windows_Cursor_Fmt 153 Windows Cursor

MS_Project_Activity_Fmt 154 Microsoft Project

MS_Project_Resource_Fmt 155 Microsoft Project

MS_Project_Calc_Fmt 156 Microsoft Project

PKZIP_Fmt 157 ZIP Archive

Quark_Xpress_Fmt 158 Quark Xpress MAC

ARC_PAK_Archive_Fmt 159 PAK/ARC Archive




• • • •••

KeyView Formats

MS_Publisher_Fmt 160 Microsoft Publisher

PlanPerfect_Fmt 161 PlanPerfect

WordPerfect_Auxiliary_Fmt 162 WordPerfect auxiliary file

MS_WAVE_Audio_Fmt 163 Microsoft Wave

MIDI_Audio_Fmt 164 MIDI

AutoCAD_DXF_Binary_Fmt 165 AutoCAD DXF

AutoCAD_DXF_Text_Fmt 166 AutoCAD DXF

dBase_Fmt 167 dBase

OS_2_PM_Metafile_Fmt 168 OS/2 PM Metafile

Lasergraphics_Language_Fmt 169 Lasergraphics Language

AutoShade_Rendering_Fmt 170 AutoShade Rendering

GEM_VDI_Fmt 171 GEM VDI

Windows_Help_Fmt 172 Windows Help File

Volkswriter_Fmt 173 Volkswriter

Ability_WP_Fmt 174 Ability

Ability_DB_Fmt 175 Ability

Ability_SS_Fmt 176 Ability

Ability_Comm_Fmt 177 Ability

Ability_Image_Fmt 178 Ability

XyWrite_Fmt 179 XYWrite / Nota Bene

CSV_Fmt 180 CSV (Comma Separated Values)

IBM_Writing_Assistant_Fmt 181 IBM Writing Assistant

WordStar_2000_Fmt 182 WordStar 2000

HP_PCL_Fmt 183 HP Printer Control Language

UNIX_Exe_PreSysV_VAX_Fmt 184 Unix Executable (PDP-11/pre-System V VAX)

UNIX_Exe_Basic_16_Fmt 185 Unix Executable (Basic-16)

UNIX_Exe_x86_Fmt 186 Unix Executable (x86)




• • • •••


14

UNIX_Exe_iAPX_286_Fmt 187 Unix Executable (iAPX 286)

UNIX_Exe_MC68k_Fmt 188 Unix Executable (MC680x0)

UNIX_Exe_3B20_Fmt 189 Unix Executable (3B20)

UNIX_Exe_WE32000_Fmt 190 Unix Executable (WE32000)

UNIX_Exe_VAX_Fmt 191 Unix Executable (VAX)

UNIX_Exe_Bell_5_Fmt 192 Unix Executable (Bell 5.0)

UNIX_Obj_VAX_Demand_Fmt 193 Unix Object Module (VAX Demand)

UNIX_Obj_MS8086_Fmt 194 Unix Object Module (old MS 8086)

UNIX_Obj_Z8000_Fmt 195 Unix Object Module (Z8000)

AU_Audio_Fmt 196 NeXT/Sun Audio Data

NeWS_Font_Fmt 197 NeWS bitmap font

cpio_Archive_CRChdr_Fmt 198 cpio archive (CRC Header)

cpio_Archive_CHRhdr_Fmt 199 cpio archive (CHR Header)

PEX_Binary_Archive_Fmt 200 SUN PEX Binary Archive

Sun_vfont_Fmt 201 SUN vfont Definition

Curses_Screen_Fmt 202 Curses Screen Image

UUEncoded_Fmt 203 UU encoded

WriteNow_Fmt 204 WriteNow MAC

PC_Obj_Fmt 205 DOS/Windows Object Module

Windows_Group_Fmt 206 Windows Group

TrueType_Font_Fmt 207 TrueType Font

Windows_PIF_Fmt 208 Program Information File (PIF)

MS_COM_Executable_Fmt 209 PC (.COM)

StuffIt_Fmt 210 StuffIt (MAC)

PeachCalc_Fmt 211 PeachCalc

Wang_GDL_Fmt 212 WANG Office GDL Header

Q_A_DOS_Fmt 213 Q & A for DOS




• • • •••

KeyView Formats

Q_A_Win_Fmt 214 Q & A for Windows

WPS_PLUS_Fmt 215 WPS-PLUS

DCX_Fmt 216 DCX FAX Format (PCX images)

OLE_Fmt 217 OLE Compound Document

EBCDIC_Fmt 218 EBCDIC Text

DCS_Fmt 219 DCS

UNIX_SHAR_Fmt 220 SHAR

Lotus_Notes_BitMap_Fmt 221 Lotus Notes Bitmap

Lotus_Notes_CDF_Fmt 222 Lotus Notes CDF

Compress_Fmt 223 Unix Compress

GZ_Compress_Fmt 224 GZ Compress

TAR_Fmt 225 TAR

ODIF_FOD26_Fmt 226 ODA / ODIF

ODIF_FOD36_Fmt 227 ODA / ODIF

ALIS_Fmt 228 ALIS

Envoy_Fmt 229 Envoy

PDF_Fmt 230 Portable Document Format

BinHex_Fmt 231 BinHex

SMTP_Fmt 232 SMTP

MIME_Fmt 233 MIME

USENET_Fmt 234 USENET

SGML_Fmt 235 SGML

HTML_Fmt 236 HTML

ACT_Fmt 237 ACT

PNG_Fmt 238 Portable Network Graphics (PNG)

MS_Video_Fmt 239 Video for Windows (AVI)

Windows_Animated_Cursor_Fmt 240 Windows Animated Cursor




• • • •••


14

Windows_CPP_Obj_Storage_Fmt 241 Windows C++ Object Storage

Windows_Palette_Fmt 242 Windows Palette

RIFF_DIB_Fmt 243 RIFF Device Independent Bitmap

RIFF_MIDI_Fmt 244 RIFF MIDI

RIFF_Multimedia_Movie_Fmt 245 RIFF Multimedia Movie

MPEG_Fmt 246 MPEG Movie

QuickTime_Fmt 247 QuickTime Movie

AIFF_Fmt 248 Audio Interchange File Format (AIFF)

Amiga_MOD_Fmt 249 Amiga MOD

Amiga_IFF_8SVX_Fmt 250 Amiga IFF (8SVX) Sound

Creative_Voice_Audio_Fmt 251 Creative Voice (VOC)

AutoDesk_Animator_FLI_Fmt 252 AutoDesk Animator FLIC

AutoDesk_AnimatorPro_FLC_Fmt 253 AutoDesk Animator Pro FLIC

Compactor_Archive_Fmt 254 Compactor / Compact Pro

VRML_Fmt 255 VRML

QuickDraw_3D_Metafile_Fmt 256 QuickDraw 3D Metafile

PGP_Secret_Keyring_Fmt 257 PGP Secret Keyring

PGP_Public_Keyring_Fmt 258 PGP Public Keyring

PGP_Encrypted_Data_Fmt 259 PGP Encrypted Data

PGP_Signed_Data_Fmt 260 PGP Signed Data

PGP_SignedEncrypted_Data_Fmt 261 PGP Signed and Encrypted Data

PGP_Sign_Certificate_Fmt 262 PGP Signature Certificate

PGP_Compressed_Data_Fmt 263 PGP Compressed Data

PGP_ASCII_Public_Keyring_Fmt 264 ASCII-armored PGP Public Keyring

PGP_ASCII_Encoded_Fmt 265 ASCII-armored PGP encoded

PGP_ASCII_Signed_Fmt 266 ASCII-armored PGP encoded

OLE_DIB_Fmt 267 OLE DIB object




• • • •••

KeyView Formats

SGI_Image_Fmt 268 SGI Image

Lotus_ScreenCam_Fmt 269 Lotus ScreenCam

MPEG_Audio_Fmt 270 MPEG Audio

FTP_Software_Session_Fmt 271 FTP Session Data

Netscape_Bookmark_File_Fmt 272 Netscape Bookmark File

Corel_Draw_CMX_Fmt 273 Corel CMX

AutoDesk_DWG_Fmt 274 AutoDesk Drawing (DWG)

AutoDesk_WHIP_Fmt 275 AutoDesk WHIP

Macromedia_Director_Fmt 276 Macromedia Director

Real_Audio_Fmt 277 Real Audio

MSDOS_Device_Driver_Fmt 278 MSDOS Device Driver

Micrografx_Designer_Fmt 279 Micrografx Designer

SVF_Fmt 280 Simple Vector Format (SVF)

Applix_Words_Fmt 281 Applix Words

Applix_Graphics_Fmt 282 Applix Graphics

MS_Access_Fmt 283 Microsoft Access

MS_Access_95_Fmt 284 Microsoft Access 95


MacBinary_Fmt 286 MacBinary

Apple_Single_Fmt 287 Apple Single

Apple_Double_Fmt 288 Apple Double

Enhanced_Metafile_Fmt 289 Enhanced Metafile

MS_Office_Drawing_Fmt 290 Microsoft Office Drawing

XML_Fmt 291 XML

DeVice_Independent_Fmt 292 DeVice Independent file (DVI)

Unicode_Fmt 293 Unicode

Lotus_123_Worksheet_Fmt 294 Lotus 1-2-3




• • • •••


15

Lotus_123_Format_Fmt 295 Lotus 1-2-3 Formatting

Lotus_123_97_Fmt 296 Lotus 1-2-3 97

Lotus_Word_Pro_96_Fmt 297 Lotus Word Pro 96

Lotus_Word_Pro_97_Fmt 298 Lotus Word Pro 97

Freelance_DOS_Fmt 299 Lotus Freelance for DOS

Freelance_Win_Fmt 300 Lotus Freelance for Windows

Freelance_OS2_Fmt 301 Lotus Freelance for OS/2

Freelance_96_Fmt 302 Lotus Freelance 96

Freelance_97_Fmt 303 Lotus Freelance 97

MS_Word_95_Fmt 304 Microsoft Word 95


Excel_Fmt 306 Microsoft Excel

Excel_Chart_Fmt 307 Microsoft Excel

Excel_Macro_Fmt 308 Microsoft Excel

Excel_95_Fmt 309 Microsoft Excel 95


Corel_Presentations_Fmt 311 Corel Presentations

Harvard_Graphics_Fmt 312 Harvard Graphics

Harvard_Graphics_Chart_Fmt 313 Harvard Graphics Chart

Harvard_Graphics_Symbol_Fmt 314 Harvard Graphics Symbol File

Harvard_Graphics_Cfg_Fmt 315 Harvard Graphics Configuration File

Harvard_Graphics_Palette_Fmt 316 Harvard Graphics Palette

Lotus_123_R9_Fmt 317 Lotus 1-2-3 Release 9

Applix_Spreadsheets_Fmt 318 Applix Spreadsheets

MS_Pocket_Word_Fmt 319 Microsoft Pocket Word

MS_DIB_Fmt 320 MS Windows Device Independent Bitmap





• • • •••

KeyView Formats


PowerPoint_2000_Fmt 323 Microsoft PowerPoint 2000


MS_Project_4_Fmt 325 Microsoft Project 4

MS_Project_41_Fmt 326 Microsoft Project 4.1


Folio_Flat_Fmt 328 Folio Flat File

HWP_Fmt 329 HWP(Arae-Ah Hangul)

ICHITARO_Fmt 330 ICHITARO V4-10

IS_XML_Fmt 331 Extended or Custom XML

Oasys_Fmt 332 Oasys format

PBM_ASC_Fmt 333 Portable Bitmap Utilities ASCII Format

PBM_BIN_Fmt 334 Portable Bitmap Utilities Binary Format

PGM_ASC_Fmt 335 Portable Greymap Utilities ASCII Format

PGM_BIN_Fmt 336 Portable Greymap Utilities Binary Format

PPM_ASC_Fmt 337 Portable Pixmap Utilities ASCII Format

PPM_BIN_Fmt 338 Portable Pixmap Utilities Binary Format

XBM_Fmt 339 X Bitmap Format

XPM_Fmt 340 X Pixmap Format

FPX_Fmt 341 FPX Format

PCD_Fmt 342 PCD Format

MS_Visio_Fmt 343 Microsoft Visio


MS_Outlook_Fmt 345 Microsoft Outlook

ELF_Relocatable_Fmt 346 ELF Relocatable

ELF_Executable_Fmt 347 ELF Executable

ELF_Dynamic_Lib_Fmt 348 ELF Dynamic Library




• • • •••


15

MS_Word_XML_Fmt 349 Microsoft Word 2003 XML

MS_Excel_XML_Fmt 350 Microsoft Excel 2003 XML

MS_Visio_XML_Fmt 351 Microsoft Visio 2003 XML

SO_Text_XML_Fmt 352 StarOffice Text XML

SO_Spreadsheet_XML_Fmt 353 StarOffice Spreadsheet XML

SO_Presentation_XML_Fmt 354 StarOffice Presentation XML

XHTML_Fmt 355 XHTML

MS_OutlookPST_Fmt 356 Microsoft Outlook PST

RAR_Fmt 357 RAR

Lotus_Notes_NSF_Fmt 358 IBM Lotus Notes Database NSF/NTF

Macromedia_Flash_Fmt 359 SWF

MS_Word_2007_Fmt 360 Microsoft Word 2007 XML

MS_Excel_2007_Fmt 361 Microsoft Excel 2007 XML

MS_PPT_2007_Fmt 362 Microsoft PPT 2007 XML

OpenPGP_Fmt 363 OpenPGP Message Format (with new packet format)

Intergraph_V7_DGN_Fmt 364 Intergraph Standard File Format (ISFF) V7 DGN (non-OLE)

MicroStation_V8_DGN_Fmt 365 MicroStation V8 DGN (OLE)

MS_Word_Macro_2007_Fmt 366 Microsoft Word Macro 2007 XML

MS_Excel_Macro_2007_Fmt 367 Microsoft Excel Macro 2007 XML

MS_PPT_Macro_2007_Fmt 368 Microsoft PPT Macro 2007 XML

LZH_Fmt 369 LHA Archive

Office_2007_Fmt 370 Office 2007 document

MS_XPS_Fmt 371 Microsoft XML Paper Specification (XPS)

Lotus_Domino_DXL_Fmt 372 IBM Lotus representation of Domino design elements in XML format

ODF_Text_Fmt 373 ODF Text

ODF_Spreadsheet_Fmt 374 ODF Spreadsheet




• • • •••

KeyView Formats

ODF_Presentation_Fmt 375 ODF Presentation

Legato_Extender_ONM_Fmt 376 Legato Extender Native Message ONM

bin_Unknown_Fmt 377 n/a

TNEF_Fmt 378 Transport Neutral Encapsulation Format (TNEF)

CADAM_Drawing_Fmt 379 CADAM Drawing

CADAM_Drawing_Overlay_Fmt 380 CADAM Drawing Overlay

NURSTOR_Drawing_Fmt 381 NURSTOR Drawing

HP_GLP_Fmt 382 HP Graphics Language (Plotter)

ASF_Fmt 383 Advanced Systems Format (ASF)

WMA_Fmt 384 Window Media Audio Format (WMA)

WMV_Fmt 385 Window Media Video Format (WMV)

EMX_Fmt 386 Legato EMailXtender Archives Format (EMX)

Z7Z_Fmt 387 7 Zip Format (7z)

MS_Excel_Binary_2007_Fmt 388 Microsoft Excel Binary 2007

CAB_Fmt 389 Microsoft Cabinet File (CAB)

CATIA_Fmt 390 CATIA Formats (CAT*)

YIM_Fmt 391 Yahoo Instant Messenger History

ODF_Drawing_Fmt 392 ODF Drawing

Founder_CEB_Fmt 393 Founder Chinese E-paper Basic (CEB)

QPW_Fmt 394 Quattro Pro 9+ for Windows

MHT_Fmt 395 MHT format

MDI_Fmt 396 Microsoft Document Imaging Format

GRV_Fmt 397 Microsoft Office Groove Format

IWWP_Fmt 398 Apple iWork Pages format

IWSS_Fmt 399 Apple iWork Numbers format

IWPG_Fmt 400 Apple iWork Keynote format

BKF_Fmt 401 Windows Backup File




• • • •••


15
• • • •••

Glossary

A

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

C

connector A connector is an Autonomy fetching solution (such as HTTP Connector, Oracle Connector, Exchange Connector, and so on) that allows you to retrieve information from any type of local or remote repository such as a database or Web site. It imports the fetched documents into IDX or XML file format and indexes them into IDOL server, from where you can retrieve them (for example by sending queries to IDOL server).

D

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

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.


• • • •••

F Glossary

15

DiSH (Distributed Service Handler)

The Distributed Service Handler provides a unified way to communicate with all Autonomy services from a centralized location. It also facilitates the licensing that enables you to run Autonomy solutions. You must have an Autonomy DiSH server running on a machine with a static known IP address.

F

fetch The process of downloading documents from the repository in which they are stored (such as a local folder, Web site, database, Lotus Domino server, and so on), importing them to IDX format, and indexing them into an IDOL server.

I

IAS (Intellectual Asset Protection System)

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

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


• • • •••

Glossary S

Q

query You can submit a natural language query to IDOL server which analyzes the concept of the query and returns documents that are conceptually similar to the query. You can also submit other query and search types to IDOL server, such as Boolean, bracketed Boolean, and keyword searches.

S

Search Unlike ordinary searches that look for keywords, the Autonomy Search allows you to enter a natural language query. The concept of the query is analyzed and documents relevant to this concept are returned to you.


• • • •••

S Glossary

15
• • • •••

Index

A

access control list (ACL) 155

actions

GetConfig 114

GetLogStream 115

GetLogStreamNames 115

GetStatistics 116

GetStatus 119

GetStatusInfo 120

MergeConfig 121

SetConfig 122

Stop 122

AdminClients (CFS) configuration parameter 72

AdminClients configuration parameter 52

AllVersions configuration parameter 61

Autonomy Content Infrastructure (ACI) 155

B

BatchSize configuration parameter 59

boolean

values 24, 38

C

configuration 23

boolean values 24, 38

example configuration file 28

file sections 25

string values 24, 38

configuration file

example 28

JobName section 27

Logging section 25

Server section 25

Service section 25

configuration parameters

AdminClients 52

AdminClients (CFS) 72

AllVersions 61

BatchSize 59

DatabaseHost 62

DatabaseInstanceName 62

DatabaseIntegratedAuth 62

DatabaseName 63

DatabasePassword 63

DatabasePort 64

DatabaseUserName 64

DatabaseVendor 64

DefaultDateRange 65

DREHostN 81

DynamicParameterName 65

DynamicParameterValue 66

EnableIngestion 54

EnableScheduledTasks 54

ErrorTaskN 81

ExtractDirectory 77

FirstDocument 66

Full 84

HashLua 76

Holder 84

Host 59

ImportFamilyRootExcludeFmtCSV 77

ImportHashFamilies 78

ImportInheritFieldsCSV 78

ImportMergeMails 79

ImportStatisticsFile 76

IndexBatchSize 82

IndexDatabase 60

IndexTimeInterval 82


• • • •••

Index C

16

JavaClasspath 55

JavaConnectorClass 56

JavaMaxMemoryMB 56

Key 84

KeyviewDirectory 79

LastDocument 66

LicenseServerACIPort 85

LicenseServerHost 86

LicenseServerRetries 87

LicenseServerTimeout 86

LogArchiveDirectory 90

LogCompressionMode 91

LogDirectory 91

LogEcho 92

LogEncryption 93

LogEncryptionKeys 93

LogExpireAction 94

LogFile 95

LogHistorySize 96

LogLevel 96

LogLevelMatch 97

LogMaxLineLength 98

LogMaxOldFiles 99

LogMaxSizeKBs 100

LogOldAction 100

LogOutputLogLevel 101

LogSysLog 102

LogTime 102

LogTypeCSVs 103

MappedSecurity 67

MaxDocuments 67

MaximumThreads 74

Number 68

Operation 87

Port 52, 60

Port (CFS) 73

PostN 74

PreN 75

QueryClients 53

QueryClients (CFS) 73

RevisionMarks 80

ScheduleRepeatSecs 57

ScheduleStartTime 58

SecurityType 69

ServiceACIMode 132

ServiceControlClients 132

ServiceHost 133

ServicePort 133

ServiceStatusClients 134

SharedPath 60

SSLCACertificate 108

SSLCertificate 108

SSLCheckCertificate 109

SSLCheckCommonName 109

SSLConfig 106

SSLMethod 110

SSLPrivateKey 110

SSLPrivateKeyPassword 111

TempDirectory 58

ThreadCount 80

WorksiteLibrary 69

connector 155

Connector Framework server 19, 26, 59

configure 39

IDX Writer 74

parameters

DREHostN 81

ErrorTaskN 81

ExtractDirectory 77

HashLua 76

ImportFamilyRootExcludeFmtCSV 77

ImportHashFamilies 78

ImportInheritFieldsCSV 78

ImportMergeMails 79

ImportStatisticsFile 76

IndexBatchSize 82

IndexTimeInterval 82

KeyviewDirectory 79

MaximumThreads 74

PostN 74

PreN 75

RevisionMarks 80

ThreadCount 80


• • • •••

K Index

D

database 155

DatabaseHost configuration parameter 62

DatabaseInstanceName configuration parameter 62

DatabaseIntegratedAuth configuration parameter 62

DatabaseName configuration parameter 63

DatabasePassword configuration parameter 63

DatabasePort configuration parameter 64

DatabaseUserName configuration parameter 64

DatabaseVendor configuration parameter 64

DefaultDateRange configuration parameter 65

Distributed Action Handler (DIH) 155

Distributed Service Handler (DiSH) 156

DREHostN configuration parameter 81

DynamicParameterName configuration parameter 65

DynamicParameterValue configuration parameter 66

E

EnableIngestion configuration parameter 54

EnableScheduledTasks configuration parameter 54

ErrorTaskN configuration parameter 81

example configuration file 28

ExtractDirectory configuration parameter 77

F

fetch 156

FirstDocument configuration parameter 66

Full configuration parameter 84

G

GetConfig service action 114

FromDisk parameter 127

Name parameter 127

Tail parameter 127

GetLogStream service action 115

FromDisk parameter 115

Name parameter 115

Tail parameter 115

GetLogStreamNames service action 115

GetStatistics service action 116

GetStatus service action 119

GetStatusInfo service action 120

H

HashLua configuration parameter 76

Holder configuration parameter 84

Host configuration parameter 59

I

IDOL server 156

IDX 156

Import Module Advanced

C functions 43

ImportFamilyRootExcludeFmtCSV configuration parameter 77

ImportHashFamilies configuration parameter 78

importing 156

ImportInheritFieldsCSV configuration parameter 78

ImportMergeMails configuration parameter 79

ImportStatisticsFile configuration parameter 76

Index fields 156

IndexBatchSize configuration parameter 82

IndexDatabase configuration parameter 60

indexing 156

IndexTimeInterval configuration parameter 82

Ingestion server 26, 59

Intellectual Asset Protection System (IAS) 156

Introduction 19

J

JavaClasspath configuration parameter 55

JavaConnectorClass configuration parameter 56

JavaMaxMemoryMB configuration parameter 56

JobName section (configuration file) 27

K

Key configuration parameter 84

KeyView

formats 137

KeyviewDirectory configuration parameter 79


• • • •••

Index L

16

L

LastDocument configuration parameter 66

LicenseServerACIPort configuration parameter 85

LicenseServerHost configuration parameter 86

LicenseServerRetries configuration parameter 87

LicenseServerTimeout configuration parameter 86

LogArchiveDirectory configuration parameter 90

LogCompressionMode configuration parameter 91

LogDirectory configuration parameter 91

LogEcho configuration parameter 92

LogEncryption configuration parameter 93

LogEncryptionKeys configuration parameter 93

LogExpireAction configuration parameter 94

LogFile configuration parameter 95

logging

set up log streams 32

Logging section (configuration file) 25

LogHistorySize configuration parameter 96

LogLevel configuration parameter 96

LogLevelMatch configuration parameter 97

LogMaxLineLength configuration parameter 98

LogMaxOldFiles configuration parameter 99

LogMaxSizeKBs configuration parameter 100

LogOldAction configuration parameter 100

LogOutputLogLevel configuration parameter 101

LogSysLog configuration parameter 102

LogTime configuration parameter 102

LogTypeCSVs configuration parameter 103

M

MappedSecurity configuration parameter 67

MaxDocuments configuration parameter 67

MaximumThreads configuration parameter 74

MergeConfig service action 121

Config parameter 121, 122, 125

DeleteKeyN parameter 121, 126

KeyN parameter 121, 128

ValueN parameter 121, 129

N

Number configuration parameter 68

O

Operation configuration parameter 87

P

password

encrypt 31

Port (CFS) configuration parameter 73

Port configuration parameter 52, 60

PostN configuration parameter 74

PreN configuration parameter 75

Q

query 157

QueryClients (CFS) configuration parameter 73

QueryClients configuration parameter 53

R

RevisionMarks configuration parameter 80

S

ScheduleRepeatSecs configuration parameter 57

ScheduleStartTime configuration parameter 58

Search 157

Secure Socket Layer connections 105

SecurityType configuration parameter 69

Server section (configuration file) 25

service actions

GetConfig 114

GetLogStream 115

GetLogStreamNames 115

GetStatistics 116

GetStatus 119

GetStatusInfo 120

MergeConfig 121

SetConfig 122

Stop 122

Service section (configuration file) 25

ServiceACIMode configuration parameter 132

ServiceControlClients configuration parameter 132


• • • •••

W Index

ServiceHost configuration parameter 133

ServicePort configuration parameter 133

ServiceStatusClients configuration parameter 134

set up

Log streams 32

SetConfig service action 122

SharedPath configuration parameter 60

SharePoint Connector

Introduction 19

SSLCACertificate configuration parameter 108

SSLCertificate configuration parameter 108

SSLCheckCertificate configuration parameter 109

SSLCheckCommonName configuration parameter 109

SSLConfig configuration parameter 106

SSLMethod configuration parameter 110

SSLPrivateKey configuration parameter 110

SSLPrivateKeyPassword configuration parameter 111

stop a connector 30

Stop service action 122

string values 24, 38

syntax

service actions 114

system architecture 21

T

TempDirectory configuration parameter 58

ThreadCount configuration parameter 80

W

WorkSite server 19

WorksiteLibrary configuration parameter 69


• • • •••

Index W

16
• • • •••