enterprise content integration services adapter ......chapter2 commonbackendcon gurationfile...

Enterprise Content IntegrationServices Adapter Installation Guide

Version 5.3March, 2005

Contains software developed by the Apache Software Foundation . Distribution subject to the Apache Software License. Contains the HTTPClient Library, © 1996-1998, Ronald Tschalaer. Distribution subject to the GNU Library General Public License. Contains the Cryptix library,Copyright © 1995-2001 The Cryptix Foundation Limited. All rights reserved. Distribution subject to the Cryptix General License. Contains theMM.MySQL driver. Copyright (c) 1998-1999 Mark Matthews. Distribution subject to the GNU Library General Public License. Contains thePager-Taglib, Copyright © 2002 James Klicman <[email protected]>. Distribution subject to the GNU Library General Public License. PortionsCopyright © 2000 World Wide Web Consortium, (Massachusetts Institute of Technology, Institut National de Recherche en Informatique et enAutomatique, Keio University). All Rights Reserved.Copyright © 1994-2005 EMC Corporation

Table of Contents

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

Chapter 1 Introduction ........................................................................................... 13A Few Terms Explained .............................................................................. 13Adapters................................................................................................ 13Adapter Bundles .................................................................................... 14Backends ............................................................................................... 14Server Root ............................................................................................ 14

Chapter 2 Common Backend Conguration File Properties .................................. 15bundle ....................................................................................................... 16host ........................................................................................................... 16port ........................................................................................................... 16protocol ..................................................................................................... 17protocolX ................................................................................................... 17home ......................................................................................................... 17action......................................................................................................... 18actionX ...................................................................................................... 18method ...................................................................................................... 18methodX .................................................................................................... 19supportsLogin ............................................................................................ 19loginName ................................................................................................. 19loginPassword............................................................................................ 20proxySet .................................................................................................... 20query ......................................................................................................... 20result ......................................................................................................... 21filter........................................................................................................... 21stopLimit ................................................................................................... 21expirationTime ........................................................................................... 22duplicate.................................................................................................... 22duplicateKey .............................................................................................. 22modificationKey ......................................................................................... 23supportsUpdate ......................................................................................... 24updateURL ................................................................................................ 24queryLanguage * (optional)......................................................................... 24strategy * (optional) .................................................................................... 25dateFormat ................................................................................................ 25encoding .................................................................................................... 25

Enterprise Content Integration Services Adapter Installation Guide 3

Table of Contents

trusted ....................................................................................................... 26supportsSubsumption................................................................................. 26maxSubsumedQueries ................................................................................ 26image ........................................................................................................ 27location...................................................................................................... 27client.overview ........................................................................................... 27client.resultIcon .......................................................................................... 28client.* properties ....................................................................................... 28

Chapter 3 Documentum ECM 5.3 ........................................................................... 29Configuration of the DFC ............................................................................ 29DocBroker Setup .................................................................................... 29DFC Setup ............................................................................................. 29DMCL Setup .......................................................................................... 30

Setting the Documentum Adapter ............................................................... 30bundle .................................................................................................. 30image .................................................................................................... 30baseName .............................................................................................. 31host ....................................................................................................... 31port ....................................................................................................... 31loginName ............................................................................................. 31loginPassword........................................................................................ 31supportsLogin ........................................................................................ 32docType ................................................................................................. 32constraint............................................................................................... 32stopLimit ............................................................................................... 32filter....................................................................................................... 33trusted ................................................................................................... 33useFTI ................................................................................................... 33location.................................................................................................. 33query ..................................................................................................... 33result ..................................................................................................... 34preferredRendition ................................................................................. 34secondaryRendition................................................................................ 34mapout.<ECIS attributes>........................................................................ 35mapin.<Documentum attributes> ............................................................ 35mapmerge.............................................................................................. 35mapmerge.<ECIS attributes> ................................................................... 36map.full-text .......................................................................................... 36attributes ............................................................................................... 37proxySet ................................................................................................ 37

Chapter 4 eRoom 7 ................................................................................................ 39Principles of the eRoom Adapter ................................................................. 39Installation of the ECI Services Script for eRoom........................................... 39Setting the eRoom Adapter ......................................................................... 40bundle ................................................................................................... 40host ....................................................................................................... 40action..................................................................................................... 41facilityName .......................................................................................... 41eRoomName .......................................................................................... 41loginName ............................................................................................. 41CustomFields ......................................................................................... 42

4 Enterprise Content Integration Services Adapter Installation Guide

Table of Contents

Chapter 5 AX 4 and 5 ............................................................................................. 43Principles of the AX Adapter ....................................................................... 43Setting the AX Adapter ............................................................................... 43bundle ................................................................................................... 44host ....................................................................................................... 44action..................................................................................................... 45login_action ........................................................................................... 45applicationName .................................................................................... 45loginName ............................................................................................. 45

applicationFields ........................................................................................ 46mapin.X ..................................................................................................... 46mapout.X ................................................................................................... 46

Chapter 6 Docushare ............................................................................................. 49Setting up a DocuShare 3.0 Adapter............................................................. 49bundle ................................................................................................... 49host ....................................................................................................... 50proxySet ................................................................................................ 50port ....................................................................................................... 50virtualDir............................................................................................... 50action1 ................................................................................................... 51action2 ................................................................................................... 51query ..................................................................................................... 51result ..................................................................................................... 52startFrom ............................................................................................... 52File.ViewCommand ................................................................................ 52User.ViewCommand .............................................................................. 52Collection.ViewCommand ...................................................................... 53loginName ............................................................................................. 53loginPassword........................................................................................ 53image .................................................................................................... 54debug .................................................................................................... 54useFTI ................................................................................................... 54map.full-text .......................................................................................... 55failOnNetworkError ............................................................................... 55agent ..................................................................................................... 56

Chapter 7 JDBC/ODBC Adapter ............................................................................. 57Principles of the JDBC/ODBC Adapter ......................................................... 57Installation and Configuration of the Database Drivers ................................. 58Using the JDBC/ODBC Bridge ................................................................. 59Using a Direct JDBC Driver ..................................................................... 59

Configuration of the Adapter Backend ......................................................... 59bundle ................................................................................................... 60query ..................................................................................................... 60result ..................................................................................................... 60trusted ................................................................................................... 61jdbcDriver.............................................................................................. 61jdbcUrl .................................................................................................. 61selectClause ........................................................................................... 62fromClause ............................................................................................ 62whereClause .......................................................................................... 62endClause .............................................................................................. 62useToDate .............................................................................................. 63likeMode................................................................................................ 63


Table of Contents

keyAttribute........................................................................................... 63result.enclosingChar ............................................................................... 63image .................................................................................................... 64dateOutputFormat.................................................................................. 64query.enclosingDate ............................................................................... 64mapin.X ................................................................................................. 64mapout.X ............................................................................................... 65ignoreCase ............................................................................................. 65

Chapter 8 ORACLE ................................................................................................ 67Configuration of the Adapter Backend ......................................................... 67

Chapter 9 Domino R5 and R6 ................................................................................. 69Principles of the Domino Adapter................................................................ 69Installation of the Domino Server ................................................................ 69Setting the Domino Adapter........................................................................ 72How to Write the Property File ................................................................ 72bundle ............................................................................................... 73query ................................................................................................. 73result ................................................................................................. 73database............................................................................................. 74view .................................................................................................. 74loginName ......................................................................................... 74loginPassword.................................................................................... 74mapin.X ............................................................................................. 75mapout.X ........................................................................................... 75port ................................................................................................... 75image ................................................................................................ 75stopLimit ........................................................................................... 76

Chapter 10 Microsoft Site Server ............................................................................. 77Principles of the MS Site Server Adapter ...................................................... 77Installation of the Microsoft Site Server ........................................................ 78Installation of the MS Site Server ............................................................. 78Installation of the ECI Services Script for MS Site Server............................ 79Setting the MS Site Server Adapter .......................................................... 80bundle ............................................................................................... 80image ................................................................................................ 80host ................................................................................................... 81port ................................................................................................... 81proxySet ............................................................................................ 81catalog ............................................................................................... 81stopLimit ........................................................................................... 82query ................................................................................................. 82result ................................................................................................. 82

Chapter 11 Sherlock ................................................................................................ 83Installing a Sherlock Plug-in ........................................................................ 83Administrating Sherlock Plug-ins ................................................................ 85Creating Sherlock Plug-ins .......................................................................... 85Sherlock Backend Properties ....................................................................... 85Image .................................................................................................... 85stopLimit ........................................................................................... 86

Chapter 12 Connect to a Source Using HTTPS ........................................................ 87


Table of Contents

Configure the Adapter with HTTPS ............................................................. 87Try to Wrap the Remote Source.................................................................... 88Check the Remote Source Certificate ............................................................ 88Save the Remote Source Certificate .......................................................... 88Add the Certificate to ECI Services Keystore File ...................................... 89


Table of Contents

List of Figures

Figure 7–1. An ECI Services query on JDBC....................................................................... 58Figure 7–2. An ECI Services Query on ODBC..................................................................... 58Figure 9–1. An ECI Services Query on Domino R5 or R6..................................................... 69Figure 9–2. Domino Server Configuration Internet Protocols - IIOP..................................... 70Figure 9–3. Domino Server Configuration Ports - Internet Ports - DIIOP .............................. 71Figure 9–4. Domino Server Configuration Security - Server Access and Security -

DIIOP Restrictions ...................................................................................... 71Figure 10–1. An ECI Services Query on MS Exchange ......................................................... 78


Table of Contents

List of Tables

Table 9–1. Association of Domino Attributes with ECI Services Attributes ........................ 72


Table of Contents


Preface

Enterprise Content Integration (ECI) Services provides content integration features:• Multi-Docbase searches• Search capabilities within external repositoriesECI Services, along with a number of other Documentum products, provides a number of features:• Cross-repository searches• Multi-repository-attribute display• Results Relevancy• Import Content• Saved Queries• Extend simple search to allow for cross-repository and virtual repository searches• Expand search results to display content from all repositories• Display relevance and location• View content from any repository• Import or include content from any repository into DCTM repositoryAccess to this functionality is provided from within DCTM 5.3 through an extended search capabilitywithin Webtop 5.3. By integrating ECI Services into the Documentum Platform, all WDK-basedDocumentum solutions have access to ECI features. All WDK-based applications (Webtop, WDKfor Portlets, DAM, DCM, WP, etc.) are now able to take advantage of the ECI features previouslystated. Users can collaborate on search results; incorporate external objects in EDM, WCM, DCM,Process Portal, or Records Management solutions.

Intended AudienceThis guide is intended for ECI Services administrators and librarians:• The administrator configures the ECI Services server. This person is responsible for

the technical configuration of the system including the definition of backends. Forinstance, the administrator would configure the Lotus Notes adapter bundle towork with the local Notes repository installed on the Intranet, therefore creating anew “ACME_Notes” backend.

• The librarian working in cooperation with the administrator has the role to organizethe backends into domains that make most sense to the end users. For instance,the librarian working in ACME Corporation could create an “ACME” domaincontaining only local backends, and specifically the local MIS backend configured bythe administrator.


Preface

These configuration tasks should always be performed using the Admin Center. Thesection 4.1 of the Admin Guide describes briefly the principles of the tool and how toconnect to its web interface. This document sometimes refers to configuration files andthe possibility to edit them. Such a manual configuration should only be performed byexperienced administrator or for trouble-shooting purposes.

Note: To manually create an adapter backend configuration file, copy an exiting backendconfiguration file to a new name. Then modify the properties as appropriate to the newinformation source. The list of general properties that can be included in a backendconfiguration file is given below.

Revision HistoryThe following changes have been made to this document.

Revision History

Revision Date Description

March, 2005 Initial Release


Chapter 1Introduction

This guide shows how to integrate a new database or a new document repository using one of theenterprise adapters offered by ECI Services.

For each of the adapters, there is a presentation of the specifications and of their behavior, as well as astep-by-step procedure to explain how to integrate a new source that uses these adapters:• Documentum ECM version 4i, 5• Documentum eRoom version 6, 7• Documentum AX version 4.6, 5.2• Xerox DocuShare version 2.x, 3.0• Lotus-Domino R5, R6• Oracle8i and later• JDBC/ODBC JDBC1, JDBC2• MS Site Server 3.0• Sherlock 2, internet search plug-insThis document assumes that you’ve already installed the ECI Services server.

For most of the adapters presented here, there is no description of how to test them. This is becauseall the adapters can be tested in the Admin Center at configuration time. They can also be manuallytested using the command aOAdapterTester. This mechanism is described in the Administrator’sguide in the section: Testing the communication with a backend.

You will note several references to Xtrim and askOnce files or programs throughout this document.Xtrim is the development and runtime foundation of ECI Services (named askOnce previously) andhas been included as part of the file names in many circumstances. For purposes of understanding,you may assume that ECI Server, askOnce and Xtrim are synonymous.

A Few Terms Explained

Adapters

An adapter links the ECI Services server to remote sources of information or documentrepositories. It manages the communication and interaction with a particular source.


Introduction

Adapters are delivered in the form of adapter bundles. For instance, a adapter developerwould develop a adapter bundle for the Microsoft Index Server search engine.

Adapter Bundles

Adapters are delivered in the form of adapter bundles. A adapter bundle is a a filewith the “.jar” extension holding all the necessary files to communicate with a typeof information source. For instance, an adapter developer would develop an adapterbundle for the Microsoft Index Server search engine and distribute as “MSIndexSvr.jar”.

Backends

A backend is the configuration of a adapter bundle for a specific source of informationavailable from a specific ECI Services server. For instance, to access a local source, theadapter bundle would be specialized to include the hostname of this source.

A backend can also allows the administrator to manage a adapter’s behavior by settingspecific properties. For instance, to apply a new filtering option for duplicated results the‘duplicateKey’ property might be changed.

Server Root

The server root is the first place the ECI Services server looks on the file system fordocuments in response to requests made through URLs. This location is typicallydefined during the server installation. ECI Services maintains the path to the server rootin the environment variable XTRIMHOME.


Chapter 2Common Backend Conguration FileProperties

The adapter bundles produced by adapter developers most often need to be configured to workin your local environment. This is done by defining and configuring adapter backends. Typicalconfiguration performed during the definition of a backend is the setting of the communicationparameters to point to a different instance of the source (for example, the local DocuShare or LotusNotes server). A backend is defined by creating a file with the name pattern: <Backend Name>.confand placing it in the same directory as the adapter bundle. The properties defined in the localconfiguration file will then override the default values from the bundle, creating a tailored backendfitting the needs of the local system. A typical backend file is given in the example Typical Content ofthe Backend File “AcmeDocushare.conf”, page 15.

Note: In this example, the version of the bundle (31) is expressed in the name of the bundle,which complies with the name pattern: <AdapterName>_v<Version>.jar. Bundle versioning is anoptional and manual activity consisting of renaming the bundle name. This is determined by theadapter developer (to fit the expressed needs of administrators). By default, version numbers are notappended to bundle names. In addition, if the backend name is the same as its corresponding bundle,and is placed in the same directory, the bundle property can be omitted as illustrated by exampleTypical Content of the Library of Congress Backend File “LoC.conf”, page 15.

Example 2-1. Typical Content of the Backend File “AcmeDocushare.conf”

bundle=core/DSWebDAV.jarhost=docushare.acme.comport=80home=http://www.acme.com

Example 2-2. Typical Content of the Library of Congress Backend File “LoC.conf”We are using default value of bundle i.e./LoC.jar and thus omitting the bundle property.host= lcweb.loc.govport=80proxySet=false

Note: Any property marked as “Mandatory” needs to be explicitly defined either in the bundleconfiguration file (as packaged by the developer of the adapter) or in the backend configuration file(that you can edit yourself).


Common Backend Conguration File Properties

bundle• Description

Name and path of the adapter bundle used for this backend. The path is specifiedfrom the adapter repository (www/wrappers) using the ‘/’ character as the pathseparator. Usually this consist of <domain name>/<backend_name>.jar

e.g. core/DocumentumFC.jar• Default value

<currentrelative_path>/<backend_name>.jar• Mandatory

Yes (No if the backend has the same name)• Visible on client

No

host• Description

The hostname of the source; an IP number or a valid DNS name such aswww.xerox.com

• Default value• Mandatory

Yes for HTTP adapter• Visible on client

No

port• Description

The port number of the server• Default value

80• Mandatory

Yes for HTTP adapter• Visible on client

No



protocol• Description

The protocol to use when connecting to the source: http or https. To disablethe remote source authentication with https, use the value: https-no-auth. E.g.protocol=https or protocol=https-no-auth

• Default value

http• Mandatory

No• Visible on client

No

protocolX• Description

The protocol to use at level X when connecting to the source: http or https. Todisable the remote source authentication with https, use the value: https-no-auth.E.g. protocol2=https or protocol2=https-no-auth

• Default value

The value of the property <protocol>• Mandatory


No

home• Description

The URL of the information repository or World-Wide Web service, e.g.,home=http://www.altavista.com

• Default value

The default value is computed using the properties host, port and protocol of thebackend: <protocol>://<host>:<port>

• Mandatory




Yes

action• Description

Relative URL address for the search interface of the target data source. (e.g.action=/go/xrx/search.cgi)


Yes• Visible on client

No

actionX• Description

Relative URL address at level X for the search interface of the target data source.(e.g. action1=/go/xrx/search.cgi)

• Default value

The value of the property <action>• Mandatory


No

method• Description

The type of HTTP request supported by the action: post or get• Default value

get• Mandatory


No



methodX• Description

The type of HTTP request supported by the action at level X: post or get. (e.g.method2)

• Default value

The value of the property <method>• Mandatory


No

supportsLogin• Description

True when this backend allows individual users to login in order to perform a searchon private or confidential data.

• Default value

False• Mandatory


Yes

loginName• Description

The default login name to use when authenticating with the source. This defaultlogin name is used for all end-users that did not specify a personal one for thisbackend.

Active only when the property supportsLogin is set to True.• Default value• Mandatory


No



loginPassword• Description

The default login password to use when authenticating with the source. This defaultlogin password is used for all end-users that did not specify a personal one for thisbackend.



No

proxySet• Description

Use the default HTTP proxy to access to source (True/False)• Default value

True• Mandatory


No

query• Description

The list of primary attributes available for querying this source• Default value

Inherited from adapter bundle• Mandatory


Yes



result• Description

The list of known attributes returned by this source• Default value



Yes

lter• Description

Results should/should-not be post-filtered before sending them to the client(True/False). The server will simply return all results returned by the source

• Default value

True• Mandatory


No

stopLimit• Description

Maximum number of results returned by this adapter.• Default value

50• Mandatory


No



expirationTime• Description

The expiration time of the adapter until it abort its execution. This time is expressedin seconds. The timer is started when the server try to establish the connection tothe source.

Related property in server.conf : xtrim.maxActionFailure• Default value

180• Mandatory


No

duplicate• Description

Duplicate results (same duplicateKey) should/should-not be removed (true/false).• Default value

True• Mandatory


Yes

duplicateKey• Description

Special attribute used to identify duplicate results from athis source, e.g., “ISBN”. Bydefault, when this attribute is absent, results are identified by their ’URL’ attribute.But some sources generate different URLs for the same result across severalinvocations. In this case this property enables to use a special attribute instead ofURL to improve the identification.

Two results are duplicates if and only if their attribute defined in ’duplicateKey’ areisidentical. By default duplicateKey is URL.

For example: Backend1: duplicateKey=title Backend2: duplicateKey not definedTtwo results extracted from Backend1 are duplicates if their attribute ’title’ areis



identical. If a result from Backend1 is compared to a result from Backend2, then thetitle of the first result is compared to the URL of the second one.

RThe results that are not duplicates are considered NEW• Default value

URL• Mandatory


Yes

modicationKey• Description

Use the property ’modificationKey’ to verify if duplicates results contain the samedata by comparing required attributes.

By default, if this property is not present in the backend, all attributes are compared(consequently two duplicate results are considered modified if at least one attributeis different between the two results).

Use the property to compare only some attributes of the results or to compare onlythe date attribute or the version attribute of the results

Compare a list of attributes modificationKey=attribute1, attribute2, ... If at least onevalue of the attributes listed is different, the two results are not identical. The mostrecently extracted result replaces the old one.

Compare the date attribute modificationKey=(date)<name of the attribute thatcontains a date value> e.g. modificationKey=(date)last_modified_date The resultwith the more recent date is retained (and additional attributes from the other resultsare merged, if they exists)

Compare the version attribute modificaactionKey=(version)<name of the attributethat contains an integer> e.g. modificationKey=(version)version_number The resultwith the highest version number is retained (and additional attributes from theother results are merged, if they exists)

• Default value

All attributes• Mandatory


Yes



supportsUpdate• Description

Indicates if the backend can be automatically updated. This property is displayed inthe adapter updater tool.

• Default value

True• Mandatory


No

updateURL• Description

Indicates the URL where new versions of the backend can be downloaded. Thisproperty is used automatically by the adapter updater tool.

• Default value

None• Mandatory


No

queryLanguage * (optional)• Description

Indicates the language used to query the source.

e.g. in Google-Italia.conf queryLanguage=italian

(applies only with the multilingual option)• Default value

None• Mandatory


Yes



strategy * (optional)• Description

Specifies a dictionnary strategy for a backend if you decide to add a specificdictionnary. (You first have to add this dictionnary in XeLDA)

(applies only with the multilingual option)• Default value

General• Mandatory


Yes

dateFormat• Description

The format of the date on the source that will be used to convert dates from the ECIServices date format to the format of the source, for example, MM/DD/YYYY

• Default value

YYYY-MM-DD• Mandatory


No

encoding• Description

The information source encoding format. This format is used during the recoveringof the information source data in order to obtain the appropriate character streamfrom an byte Stream.

• Default value

windows-1252• Mandatory


No



trusted• Description

The list of attributes that are trusted. That is to say that no filtering will be done onthose attributes. This is useful when a source does not return the full content of anattribute, like “body” in the case of AltaVista, but we can still “trust” the selectionand filtering of results implemented by AltaVista.

Note: It also applies to an attribute that is never returned by the source but still is“trusted”. For example, a source supporting a search on “keywords” but that doesnot return a “keywords” attribute.

A search on “full-text” always matches when some attributes are configured astrusted.



Yes

supportsSubsumption• Description

Set to ‘true’ to allow the translation of the ECI Services query into severalsub-queries when the OR operator is not supported. Indeed the ECI Services query{title,CONTAINS, printer OR scanner} is translated into query1 {title,CONTAINS,printer} and query2 {title,CONTAINS,scanner} when the OR is not supported bythe source.

• Default value

true• Mandatory


Yes

maxSubsumedQueries• Description

The maximum number of sub-queries allowed when ‘supportsSubsumption’ is set to‘true’. If the ECI Services query is translated into m sub-queries and only n (n<m)sub-queries are allowed, only the n first queries are sent to the source.



• Default value

5• Mandatory


Yes

image• Description

Special logo used to represent results from this backend; if the value ofthis property is “ACME” (e.g. image=ACME); the logo should be stored in:www/tomcat/webapps/ao/data/sources/source-acme.gif

Note: Image name must always be in lower case• Default value

www/tomcat/webapps/ao/data/sources /source-<backend_name>.gif• Mandatory• Visible on client

Yes

location• Description

A coordinate pair for the location of this backend on the default world map (latitude,longitude)


DEPRECATED IN V3• Visible on client

YesTo get the coordinate of any (public) machine on the Internet, you can use the followingUIUC service: http://cello.cs.uiuc.edu/cgi-bin/slamm/ip2ll/

client.overview• Description



A comma separated list of attributes which will constitute the overview field inthe HTML interface (Ex.:abstract,body).

• Default value

abstract,body• Mandatory


Yes

client.resultIcon• Description

The name of the icon to display with results coming from this backend.

webapps/ao/data/sources/icon-<resultIcon>.gif image will be displayed with everyresult coming from the adapter ( height = 25 ), if the property is not null.

• Default value

null• Mandatory


Yes

client.* propertiesEach adapter backend can define custom properties for an ECI Services interface.

These properties are necessarily prefixed by ’client’ and are returned ’as is’ to the clientinterface which is based on ECI Services APIs.

The client.overview property above is a good example of this usage.


Chapter 3Documentum ECM 5.3

The purpose of the Documentum adapter is not only to allow the ECI Services client to query aDocumentum Docbase, but also to allow the end-user to visualize the documents that are presenton the Documentum Content Server.

The communication between the adapter and the Docbase is performed using the Documentum DFClibrary. The DFC is based on the native DMCL library. As such the Documentum adapter should becompatible with previous versions of the Documentum content server such as Documentum 4i.

For administrators upgrading from ECI Services V3, be aware that the new version of the adapter forDocumentum no longer requires the setup of a dedicated HTTP gateway. This vastly simplifies theconfiguration of the adapter as well as removes the need to activate another web server.

Conguration of the DFCThe Documentum adapter does not require the DFC to be pre-installed on the ECIServices server. ECI Services comes with its own set of DFC components.

DocBroker Setup

Open the file:

<ECIS directory>\lib\dfc\config\dmcl.ini

Edit the line below to point to the proper Docbroker:

host = <your-doc-broker-hostname>

As an alternative, you can also copy an existing DMCL.ini file to replace this one.

DFC Setup

Open the file:

<ECIS directory>\lib\dfc\config\dfc.properties

Edit the line below to point to this installation of ECI Services:


Documentum ECM 5.3

dfc.data.dir=C\:/ecis/lib/dfc (on Windows)

DMCL Setup

Windows and Solaris distribution are pre-configured.

On Linux, open the file:

<ECIS directory>\install\wrappers\documentum.zip

And extract the content of the <linux> directory into:

<ECIS directory>, e.g., /usr/tools/ecis

Setting the Documentum AdapterLogon to the ECI Services Admin Center, go to the domains page and then click on Addto create a backend configuration for your Docbase. The configuration wizard will helpyou with the setup of the backend. As an alternative you can also consult pre-existingconfigurations available in the directory:<ECIS directory>/www/wrappers/documentumFCBackends/

The remainder of this section presents the main properties to include in the configurationfile for a new Documentum backend.

bundle

• Description

Name and path of the adapter bundle used for this backend. The path is specifiedfrom the adapter repository (www/wrappers). Name and path of the adapterbundle used for this backend. The path is specified from the adapter repository(www/wrappers).

• Default value

core/DocumentumFC.jar

image

• Description

Special logo used to represent results from this backend; if the value of this propertyis “XX”; the logo should be stored in: www/tomcat/webapps/ao/data/sources/source-XX.gif

• Default value


Documentum ECM 5.3

www/tomcat/webapps/ao/data/sources/source-<backend_name>.gif• Visible on client

Yes

baseName

• Description

The name of the Docbase to connect to (for example dm_my_docbase)• Default value

host

• Description

For display purpose, hostname to include in the URL of the document. Usually thiswould be the name of the Documentum server.

• Default value

port

• Description

For display purpose, port number to include in the URL of the document.• Default value

80

loginName

• Description

Name of a Documentum user.If this property and the property loginPassword are set,they will be used for every ECI Services user to log into the Docbase.

Default value

loginPassword

• Description

Password of the Documentum user.If this property and the property loginName are set,they will be used for every ECI Services user to log into the Docbase.


Documentum ECM 5.3

• Default value

supportsLogin

• Description

Set to true as the Documentum API allows users to authenticate themselves whenperforming a search. When the end-user does not specify any login, the guest login(‘loginName’) defined above is used.

• Default value

true

docType

• Description

The name of the Documentum collection you perform the search. It should be asubtype of dm_sysobject (example dm_document, dm_folder, dm_method).

• Default value

dm_document

constraint

• Description

Extra constraint to add to the where clause of the DQL query.• Default value

SELECT r_object_id FROM <docType>• Option

FOLDER (’/Documents’, descend)

stopLimit

• Description

The maximum number of results sent by the Documentum server per search.• Default value

200


Documentum ECM 5.3

lter

• Description

Results should/should-not be post-filtered before sending them to the client(true/false).

• Default value

Default value

trusted

• Description

No filtering will be done by ECI Services on this list of attributes. Often used whenthe source sends only partial results (i.e. only 10 first words). This list MUST contain‘body’ when ‘useFTI’ is set to true (I.e. the Documentum base is full-text indexed).

• Default value

useFTI

• Description

Set to true if the docbase has a working full-text Index that you want to use for searchon the ‘full-text’ attribute. If it is set to true do not forget to add ‘body’ in the list of‘trusted’ in order to not remove valid results.

• Default value

false

location

• Description

A coordinate pair for the location of this backend on the default world map (latitude,longitude).

• Default value• Visible on client

Yes

query

• Description


Documentum ECM 5.3

The list of primary attributes available for querying this source.• Default value

title, author, abstract, keywords, file_name, date, size, full-text• Visible on client

Yes

result

• Description

The list of known attributes returned by this source.• Default value

title, author, abstract, keywords, file_name, date, last_modified_date, size, URL• Visible on client

Yes

preferredRendition

• Description

This property applies when the user requests to view a document. The documentwill be returned in the following rendition if available. If this rendition is notavailable, the property secondaryRendition will be used.

The rendition corresponds to the name of the format in the docbase: msw8 (forWord), pdf, text.

• Default value

secondaryRendition

• Description

This property applies when the user requests to view a document and when thedocument is not available in the preferred rendition. The document will be returnedin the following rendition if available. If this rendition is not available, the originaldocument will be returned.

The rendition corresponds to the name of the format in the docbase: msw8 (forWord), pdf, text.

• Default value


Documentum ECM 5.3

mapout.<ECIS attributes>

• Description

Defines the internal name of each queryable ECI Services attribute for the query.

i.e. mapout.<ECIS attribute name>=<Documentum attribute name>

Example 3-1. mapout.<ECIS attributes>

mapout.file_name=object_namemapout.author=ANY authors

Note: This property is mandatory for this adapter, more particularly forDocumentum repeating attributes (i.e., attributes that need ‘ANY’ before theattribute name).

• Default value

mapin.<Documentum attributes>

• Description

Defines the internal name of each queryable ECI Services attribute for the result

i.e. mapin.<Documentum attribute name>=<ECIS attribute name>

Example 3-2. mapin.<Documentum attributes>

mapin.r_modify_date=last_modifiedmapin.authors=author

Note: This property is mandatory for this adapter, more particularly forDocumentum repeating attributes. However in ‘mapin’ do not add ‘ANY’ onDocumentum attributes.

• Default value• Visible on client

Yes

mapmerge

• Description

Defines a list of special attributes to merge with exclusive Or, or with And for thequeries and the results. [optional property]

Example 3-3. Syntax

mapmerge=<ECIS attribute names>

Note: This property is only available for the Documentum adapter.• Default value


Documentum ECM 5.3

mapmerge.<ECIS attributes>

• Description

Define the type of merge (exclusive Or with ‘|’ or And with ‘+’). [optional property]

Example 3-4. Syntax

mapmerge.<ECIS attribute name>=<Documentum attribute name>|<Documentumattribute name>mapmerge.< ECIS attribute name >=< Documentum attribute name >+< Documentum attribute name >

Example 3-5. Example

mapmerge=tilte,authormapmerge.title=title|object_nameIt means for a query defined in ECI Services on the attribute title (i.e., ‘title,CONTAINS, java), the query sent to Documentum will be on both attributes title andobject_name (i.e., ‘title, contains, java OR object_name, contains, java’). For the results‘mapmerge.title=title|object_name’ means that if title is defined in Documentum, thetitle value in ECI Services is the same as Documentum title value, otherwise the titlevalue in ECI Services contains the object_name value sent by Documentum.

mapmerge.author=author+owner_name,means that a query defined in ECI Serviceson the attribute ‘author’ will be send on both attributes ‘authors’ and ‘owner_name’in Documentum. For the results in ECI Services , the author value is the list ofauthors sent by Documentum concatenated with the owner_name value.

Note: This property is only available for the Documentum adapter.• Default value• Visible on client

Yes

map.full-text

• Description

Define a list of Documentum attribute names to map the ECI Services attribute‘full-text’.

This property is ignored when ‘useFTI’ is set to true.

Example 3-6. Example

map.full-text=title,ANY keywords,subjectThe ECI Services query is ‘full-text, contains, knowledge’. So, the Documentumquery becomes ‘title,contains,Knowledge OR ANY keywords,contains,KnowledgeOR subject,contains,Knowledge’.



Documentum ECM 5.3

object_name, title, subject, ANY keywords, ANY authors, r_creation_date,r_modify_date, r_content_size, a_content_type, owner_name

attributes

• Description

This property is mandatory for the Documentum adapter.

This is the list of Documentum attribute names that will be sent by Documentumgateway for every search. Whatever the attributes defined in the query, theDocumentum server will display this list of attributes for each results.


object_name, title, subject,keywords,authors,r_creation_date, r_modify_date,r_content_size,a_content_type,owner_name

proxySet

• Description

Use the default HTTP proxy to access to source. (Set to false for intranet source.)(true/false)

• Default value

false


Documentum ECM 5.3


Chapter 4eRoom 7

The eRoom adapter enables the ECI Services client to query the eRoom Server in order to consultstored items and documents and allows the final user to visualize the documents selected.

This adapter works with eRoom 7 as well as legacy eRoom 6 servers.

Principles of the eRoom AdapterThe most important thing to notice is that the ECI Services server is not in direct relationwith the eRoom server.

To query a database, the ECI Services server will use its own ASP script stored in theeRoom Server. The eRoom Server will execute this script in order to obtain the querydescription and to consult its folders. This script will then retrieve the data extracted tothe ECI Services server and the ECI Services server will wrap the results and displaythem to the end-user.

Installation of the ECI Services Script foreRoom

You can find the script at the following location:

<ECIS directory>/install/wrappers/eRoom/ECISSearch_eRoomv7.asp

Or for eRoom 6:

<ECIS directory>/install/wrappers/eRoom/ECISSearch_eRoomv6.asp

Create a specific directory on the eRoom Server for the ECI Services script for eRoom

E.g. c:\Inetpub\scripts\ECISAdapter

Copy the script file and rename it as ECISSearch.asp in this directory

Create an alias for the IIS Server on this directory, with read and script access rights.

E.g. ECISAdapter


eRoom 7

Setting the eRoom AdapterThis section describes how to create the adapter backend on your ECI Services server.

Choose a host repository for your backend.

This directory has to be over <ECIS repository>/www/wrappers. You can choose to useone that already exists or to create your own.

Let’s say from now on that this directory is:

<ECIS repository>/www/wrappers/portal/eroomBackends.

Create the entry for your backend in the domains.conf file (explained in theAdministrator.s Guide).

Add/create the configuration files for the new backend.

Reminder:

For each adapter at least two files are required: (Let’s say we want to consult the eRoom calledFolder1, the name of the backend file could be eRoomFolder1.conf) eRoomFolder1.conf andeRoomFolder1_en.properties.

If you are using a locale, you must add the localized properties file such aseRoomFolder1_fr.properties for the French locale.

You can set other properties as described in the Administrator’s Guide. The followinglist presents the most common properties that can be changed on an eRoom adapter.

Known Limitation: custom fields containing dates are not supported.

bundle

• Description

Name and path of the adapter bundle used for this backend. The path is specifiedfrom the adapter repository (docs/adapters).

• Default value

portal/eRoom.jar• Mandatory

Yes

host

• Description

The name of the server hosting the eRoom• Default value• Mandatory


eRoom 7

Yes

action

• Description

Relative URL address for the search interface of the target data source. (here, theECISSearch.asp page, in its aliased directory)

E.g. ECISAdapter/ECISSearch.asp• Default value• Mandatory

Yes

facilityName

• Description

The eRoom facility to be searched. Use the ’URL name’ of the facility, not the ’displayname’.

E.g. facilityName=myFacility• Value• Mandatory

Yes

eRoomName

• Description

List of eRoom(s) to be searched in this facility. Use the ’URL name’ of the eRoom, notthe ’display name’. List separator is comma ’,’

E.g. eRoomName=ClientEngagementV6,LeadGeneration,myRoom• Default value• Mandatory

No

loginName

• Description


eRoom 7



YesDescription

Default value

Mandatory

CustomFields

• Description

List of custom fields in this facility.

Custom Fields should be listed here AND added to the query and/or result propertyif you would like it to be queriable or to appear in the results.

Custom Fields name should not contain ’ ’.

Custom Fields name suffix should reflect its type: XXX_date for a date and,XXX_nume for a numerical. Others are treated as string.

E.g. customFields=birth-city,temperature,birth_date

Date custom fields are not supported.• Default value• Mandatory

No


Chapter 5AX 4 and 5

The AX adapter enables the ECI Services client to query the AX Server in order to consult stored itemsand documents and allows the final user to visualize the documents selected.

This adapter works with AX 4.6 and AX 5.2.

Principles of the AX AdapterThe most important thing to notice is that the ECI Services server is not in direct relationwith the AX server.

To query a database, the ECI Services server will use its own set of ASP scripts storedin the AX Server. The AX Server will execute the scripts in order to obtain the querydescription and to consult its folders. This script will then retrieve the data extracted tothe ECI Services server and the ECI Services server will wrap the results and displaythem to the final user.

Please consult the documentation for AX Server to activate the ECI Addendum for AX:IEciResultSet.asp, IDocView.asp

Setting the AX AdapterThis section describes how to create the adapter backend on your ECI Services server.

One backend is dedicated to an AX Application.




<ECIS repository>/www/wrappers/core/AXbackends

Create the entry for your backend in the domains.conf file (explained in theAdministrator.s Guide).



AX 4 and 5

Reminder:

For each adapter at least two files are required: (Let’s say we want to consult the AXapplication called application1, the name of the backend file could be AXApplication1.conf)AXApplication1.conf and AXApplication1_en.properties.

If you are using a locale, you must add the localized properties file such AXApplication1_fr.properties for the French locale.

You can set other properties as described in the Administrator’s Guide. The followinglist presents the most common properties that can be changed on an AX adapter.

AX application fields:

ECI Services requires a "title" attribute.

When creating a backend on an AX application, the administrator requires:• Searchable application fields (for the ‘application_fields’ and ‘query’ backend

properties)• All the results application fields (• Searchable application fields with special characters, like ‘ ‘, ‘#’ (for mapin/mapout

backend properties)• The field to map to the ‘title’ (mandatory) : ‘title’ and ‘field’ will be displayed with

the same values (field that best identifies the result).All the other fields do not require mapin/mapout handling.

bundle

• Description• Default value• MandatoryName and path of the adapter bundle used for this backend. The path is specified fromthe adapter repository (docs/adapters).

Value

core/AX.jar

Yes

host

• Description

The name of the server hosting AX• Default value• Mandatory

Yes


AX 4 and 5

action

• Description

Relative URL address for the search interface of the target data source. (here, theIEciResultSet.asp page, in its aliased directory)

E.g. /IEciResultSet.asp• Default value• Mandatory

Yes

login_action

• Description

Relative URL address for the login interface of the target data source.

E.g. /login.asp• Default value• Mandatory

Yes

applicationName

• Description

The AX application to be searched.

E.g. applicationName=MYAPPLICATION• Default value• Mandatory

Yes

loginName

• Description




AX 4 and 5

Yes

applicationFields• Description

List of the application fields.

Application Fields should be listed here AND added to the query and/or resultproperty if you would like it to be queriable or to appear in the results.

Application Fields name should not contain ’ ’.• Default value• Mandatory

No

mapin.X• Description

The list of mapin.X properties explicitly describe how the remote source X attribute(i.e. the row names) is translated in the internal ECI Services attribute names.

• Default value

E.g., mapin.NAME=title

means that " NAME" which will be received from the remote source will be addedin ECI Services as "title"

• Mandatory

mapout.X• Description

The list of mapout.X properties defines how the ECI Services attribute X is translatedinto an attribute of the source (i.e. the name of the corresponding row).

• Default value

E.g., mapout.title=NAME

means that "title" will be sent to the source as "NAME"• Mandatory

Yes. The ECI Services AX adapter uses the association between internal attributesand the attributes of the source when translating the query. Attributes without suchassociation are not considered during the translation phase.


AX 4 and 5

Note: Always use “mapin.” and “mapout.” notation for attributes names containingspecial characters.


AX 4 and 5


Chapter 6Docushare

This document starts with the most simple core adapter to configure. To add a DocuShare adapter onyour ECI Services server, you just have to modify the file www/docs/conf/domains.conf in order toadd a new entry for the backend, and then to write a conf file on the backend.

Add the entry for your adapter in www/docs/conf/domains.conf (explained in the administratorguide)

Setting up a DocuShare 3.0 AdapterThe DocuShare 3.0 adapter uses a special communication protocol , which name iscalledWebDAV. That’s why the name of the bundle is core/DSWebDAV.jar.

Using this adapter it is possible for individual users to search a DocuShare repositoryusing their own private account. Please refer to the User’s Guide to see how anindividual user sets this information.

For most of the DocuShare adapters, you just have to set the following properties:

bundle

host

proxySet

You can set other properties as described in the Administator’s guide. But the followinglist presents most common ones that can be changed.

bundle

• Description

Name and path of the adapter bundle used for this backend. In this case: DocuShare.The path is specified from the adapter repository (www/wrappers). Name and pathof the adapter bundle used for this backend.

• Default value

core/DSWebDAV.jar• Mandatory


Docushare

Yes

host

• Description

The hostname of the source; an IP number or a valid DNS name such aswww.xerox.com


Yes

proxySet

• Description

Use the default HTTP proxy to access to source (True/False)• Default value

True• Mandatory

No

port

• Description

The port number of the server• Default value

80• Mandatory

No

virtualDir

• Description

The virtual directory in which DocuShare was set up in the hosting webserver. For example if URLs in your DocuShare repository have the form ofhttp://myMachime.mydomain.com/myVirtualDir /dscgi/ds.py/View/Collection-13

Then specify the value “/myVirtualDir” to the virtualDir parameter


Docushare

• Default value

None• Mandatory

No

action1

• Description

The CGI-script invoked to allow the adapter to be logged into DocuShare (mostlyleave unchanged)

• Default value

/dscgi/ds.py/Login• Mandatory

No

action2

• Description

The CGI-script invoked to the search on a DocuShare source (mostly leaveunchanged)

• Default value

/dscgi/ds.py/Search• Mandatory

No

query

• Description



No: defined in the default DocuShare configuration• Visible on client

Yes


Docushare

result

• Description




Yes

startFrom

• Description

Use this property to reduce the scope of the search to a subfolder of the DocuSharetree. Assign the name of a collection from which the search will start.

• Default value



Yes

File.ViewCommand

• Description

Define this property if you want to use another template to display the DocuShareobjects than the standard one. The DocuShare administrator usually knows thisinformation.

• Default value

/dscgi/ds.py/Get• Mandatory

No

User.ViewCommand

• Description


Docushare


• Default value

/dscgi/ds.py/ViewProps• Mandatory

No

Collection.ViewCommand

• Description


• Default value

/dscgi/ds.py/View• Mandatory

No

loginName

• Description



No

loginPassword

• Description



No


Docushare

image

• Description


• Default value

www/tomcat/webapps/ao/data/sources/source-docushare.gif• Mandatory


Yes

debug

• Description

Add debug traces in the server console.• Default value

false• Mandatory


No

useFTI

• Description

Indicate if the adapter should use the Docushare Full-Text Search functionality.

If useFTI is set to true, ’full-text’ will be mapped to the documents content (it isslower but search recall is better).

If useFTI is set to false, ’full-text’ will be mapped to a set of attribute according to theproperty map.full-text (see below), but the performance will be improved.

• Default value

true• Mandatory



Docushare

No

map.full-text

• Description

Define this list to map full-text (that means a search on any attributes) to severalattributes (when useFTI==false).

When useFTI=false, a constraint defined on full-text will be translated in constrainton all these attributes connected by ’OR’.

Example 6-1. map.full-text’full-text, CONTAINS, java’ is mapped in DocuShare to’description,CONTAINS,JAVA OR title,CONTAINS,JAVA ORsubject,CONTAINS,JAVA OR keywords,CONTAINS,JAVA OR ...

• Default value

title, abstract, description, keywords, owner, collection, abstract.File

Note: It is the fact that abstract.File is used in the mapping that takes the most time,but it is still twice more efficient than having useFTI=true.

• Mandatory


NoDescription

Default value

Mandatory

failOnNetworkError

• Description

By default a re-connection is retried 5 times in case of network error.

Set this property to true if you want no retry at all.• Default value

false• Mandatory


No


Docushare

agent

• Description

Name used by the ECI Services server to identify itself to an HTTP server. Sometimesneeded when a server returns pages that target a specific Web browser.

For example, to fake being Netscape Navigator, the adapter should use ’Mozilla/4.0’ .

For DocuShare V3 backends, please use the following agent: DsAxess/4.0• Default value

Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0; ECIS V4; Documentum;[email protected])

• Mandatory


No


Chapter 7JDBC/ODBC Adapter

Java supports a protocol named JDBC (Java Database Connectivity) to communicate and toquery a relational databases system (RDBMS). Through JDBC it is virtually possible to connectECI Services with any RDBMS on the market. More information about JDBC can be found at:http://java.sun.com/products/jdbc/

For RDBMS that do not currently provide a native JDBC driver, it is possible to use an ODBC driverinstead by using the Java built-in JDBC/ODBC bridge. ODBC (Open Database Connectivity) is awidespread standard to communicate with RDBMS. Most RDBMS provide an ODBC driver.

When an RDBMS both provides JDBC and ODBC drivers, it is best to use the native JDBC driver,which provides better performance within ECI Services and requires less manual administration work.

The next section explains how to add a new JDBC or ODBC sources to your ECI Services server.

Principles of the JDBC/ODBC AdapterThis section briefly describes the capabilities of the JDBC/ODBC adapter:

The Figure below presents the communication between the participants of a request ona relational database contacted with native JDBC driver. When the user performs aquery, the ECI Services server uses the JDBC driver to handle the communication withthe database possibly located on an another computer.


JDBC/ODBC Adapter

Figure 7-1. An ECI Services query on JDBC

presents the communication between the participants of a request on a relationaldatabase contacted with an ODBC driver through the Java built-in JDBC/ODBC bridge.When the user performs a query, the ECI Services server uses the bridge to accessthe ODBC driver installed on the server machine. The ODBC driver then handles thecommunication with the database possibly located on an another computer.

Figure 7-2. An ECI Services Query on ODBC

Installation and Conguration of the DatabaseDrivers

As described in the previous section, there are two ways to add a new adapter talkingto a RDMS: use the ODBC driver (through JDBC/ODBC Bridge), or use a specific JDBC


JDBC/ODBC Adapter

driver for your source. If the database vendor provides a native JDBC driver for Java,it is recommended to use it since it will lead to better performance and to a shorterresponse time for your end-users.

The following sections describe how to configure or install those drivers.

Using the JDBC/ODBC Bridge

Declare your ODBC source the computer hosting ECI Services.

If you decide to use the ODBC driver, you need to declare your ODBC source on yoursystem. (This is not explained here.) If you are using Windows NT, you can follow thesteps described below which illustrates this process with a Microsoft Excel database.Otherwise, please refer to the ODBC management section of your operating systemonline help.

Launch the Windows NT control panel, choose the “ODBC data sources” configurationpanel and choose the System DSN (Data Source Name).

Then add a new source by clicking on the Add button and select the driver correspondingto your database, for example Microsoft Access Driver.

Finally, configure your ODBC driver with the information specific to your database.

Using a Direct JDBC Driver

To be able to correctly follow the procedure presented in this section, you need someknowledge on Java. If you don’t know what is the CLASSPATH, you may need to ask forhelp from someone who knows.Get the JDBC driver for your source.

For many information sources, you can download it for free on the Web, or you can askdirectly your database provider if it provides a JDBC driver for your system. It is a Javalibrary that you can save under <ECIS>/lib/jars<MyJDBCDriver> for example.

Note: For an Oracle adapter, the previous steps are not required since ECI Services shipswith the Oracle JDBC native drivers (Refer to lib\oracle\jdbc\README.txt.

Conguration of the Adapter BackendThis section describes how to create the adapter backend on your ECI Services server.

Choose a host repository for your backend. This directory has to be over <ECISrepository>/www/wrappers. Choose to use one that already exists or to create your own.For this example, the directory is: <ECIS repository>/www/wrappers/ODBC.

Create the entry for your backend in the domains.conf file. (this is explained in theAdministrator Guide)


JDBC/ODBC Adapter

Add/create the configuration files for the new backend from the template file available indocs\templates\adapter\JdbcSampleAdapter

Note: For each adapter at least two files are needed:

MyJDBCBase.conf and MyJDBCBase_en.properties.

If you are using a locale, you must add the localized properties file likeMyJDBCBase_fr.properties for the French locale.

You can set other properties as described in the Administator’s guide. But the followinglist presents most common ones that can be changed for a JDBC adapter.

bundle

• Description


• Value

core/Oracle.jar (for an Oracle database)

core/Jdbc.jar (for all other databases)

query

• Description

The list of primary ECI Services attributes available for querying this source• Visible on client

Yes in the domain browser

result

• Description

The list of known ECI Services attributes returned by this source• Visible on client

Yes in the domain browser


JDBC/ODBC Adapter

trusted

• Description

The list of attributes that are trusted. That is to say that no filtering will be done onthose attributes. This is useful when a source does not return the full content ofan attribute.

• Default value

empty

jdbcDriver

Do NOT set this property if you are using the JDBC/ODBC bridge or if you areconfiguring an Oracle adapter.

• Description

For adapters using a native JDBC driver, this property should hold the name of theentry class of the JDBC native driver (refer to the documentation of your native JDBCdriver for more details.) This class must be accessible with your CLASSPATH.

e.g. com.imaginary.sql.msql.MsqlDriver

e.g. com.microsoft.jdbc.sqlserver.SQLServerDriver

For adapters using the JDBC/ODBC bridge, this property should be commented outto let the default value active.

• Default value

sun.jdbc.odbc.JdbcOdbcDriver. This value has not to be changed if you’ve chosento use the JDBC/ODBC bridge.

jdbcUrl

• Description

The source URL, jdbcUrl=jdbc:odbc:<database name in ODBC drivers>

E.g. jdbcUrl=jdbc:odbc:db1 (the jdbc URL of the Lotus Notes server)• Value

E.g., jdbcUrl=jdbc:odbc:My_ODBC_DB

To connect to an Oracle database:

jdbcUrl = jdbc:oracle:thin:@database_hostname:database_port:database_name.

To connect to a SQLServer database:

jdbcUrl=jdbc:microsoft:sqlserver:// database_hostname:database_port


JDBC/ODBC Adapter

selectClause

• Description

The select clause of the SQL request sent to the source. This corresponds to the nameof the rows to insert in results.

• Value

E.g., selectClause= publication_date,title,publisher,author,borrowing_status,isbn_issn

To connect to an Oracle database:

jdbcUrl = jdbc:oracle:thin:@database_hostname:database_port:database_name.

To connect to a SQLServer database:

jdbcUrl=jdbc:microsoft:sqlserver:// database_hostname:database_port

fromClause

• Description

The from clause of the SQL request sent to the source, in your lotus notes, if you openthe database, the fromClauose represents the Forms selected in the design options.

In usual RDMS, this attribute should contain the name of the table to search.• Value

E.g., fromClause=Employees

whereClause

• Description

The beginning of the where clause of the SQL request sent to the source. Thisattribute is optional and can be commented out.

• Value

E.g., dm_sysobject_s.r_object_id_i=dm_sysobject_r.r_object_id_i

endClause

• Description

The end of the SQL request sent to the source. This attribute is optional and canbe commented out.

• Value

E.g., endClause=)


JDBC/ODBC Adapter

useToDate

• Description

SQL to_date function is available or not. “yes” if the SQL to_date function issupported (default). “no” if just send date as-is.

• Default value

no• Value

E.g., useToDate=no or useToDate=yes

likeMode

• Description

A string describing how we translate the CONTAINS operator of the ECI Servicesquery. The CONTAINS operator is translated in a like operator that is often LIKEor CLIKE.

Default value

LIKE• Value

E.g., likeMode= CLIKE

keyAttribute

• Description

You need to setup this property for Jdbc adapters, which have to treat theaccumulation of several rows into one hit.

• Value

E.g., likeMode= CLIKE

result.enclosingChar

• Description

The characters that enclosed the results given by the source. It is often ’ or nothing• Default value

nothing• Value

E.g., result.enclosingChar= ’


JDBC/ODBC Adapter

image

• Description


• Default value


Yes

dateOutputFormat

• Description

The format of the date on the source used to convert dates from the ECI Servicesdate format to the format of the jdbc source, e.g., MM/dd/yyyy. This property isMandatory if your query format could contain ECI Services attribute: "date"

• Value

E.g., dateOutputFormat = MM/dd/yyyy

query.enclosingDate

• Description

The characters that enclosed the date attribute in the SQL query send to the source. Itis often ’ (mySQL) or # (ODBC)

example:

JDBC: SELECT * FROM PeerReviews WHERE (PeerReviews.Date)>#12/12/1999#)

mySQL: SELECT * FROM Library1 WHERE publication_date< ’01-Oct-1994’• Default value

# (because the default driver is sun.jdbc.odbc.JdbcOdbcDriver)

mapin.X

• Description

The list of mapin.X properties explicitly describe how the remote source X attribute(i.e. the row names) is translated in the internal ECI Services attribute names.

• Value


JDBC/ODBC Adapter

E.g., mapout.date=mapin.library1.title=title

means that "library1.title" which will be received from the remote source will beadded in ECI Services as "title"

mapout.X

• Description

The list of mapout.X properties defines how the ECI Services attribute X is translatedinto an attribute of the source (i.e. the name of the corresponding row).

• Value

E.g., mapout.date=table1.publication_date

means that "date" will be sent to the source as "table1.publication_date"• Mandatory

Yes. The ECI Services JDBC adapter uses the association between internal attributesand the attributes of the source when translating the query. Attributes without suchassociation are not considered during the translation phase.

Note: Always use “mapin.” and “mapout.” notation. Even if, ECI Services attribute hasthe same name than the field of your database. Otherwise this field wouldn’t be fetched.

ignoreCase

The following property is specific to the Oracle adapter. It needs to be set at FALSE forany other kind of jdbc adapter.(e.g. Access database).

• Description

This property allows the administrator to configure the case sensitivity of its Oracleadapter.

• Default value

true (e.g. case insensitive)• Value

E.g., ignoreCase=false (case sensitive)


JDBC/ODBC Adapter


Chapter 8ORACLE

ECI Services provides a adapter able to communicate with Oracle 8i and above. This adapter isactually a JDBC adapter that uses a library from Oracle. That’s why most of the properties of thisadapter are similar to those of a JDBC adapter.

The only difference is that the procedure is simpler because you DO NOT have

to download the JDBC library for Oracle, because it is already done for you in the ECI Servicesdefinition.

set the property JdbcDriver (by default jdbcDriver=oracle.jdbc.driver.OracleDriver)

This means that you can go now and follow the procedure presented in Configuration of the AdapterBackend, page 67.

Conguration of the Adapter BackendThe ignoreCase property is specific to the Oracle adapter:• Description

This property allows the administrator to configure the case sensitivity of its Oracleadapter.

• Default value

true (e.g. case insensitive)• Value

E.g., ignoreCase=false (case sensitive)


ORACLE


Chapter 9Domino R5 and R6

Principles of the Domino AdapterThis section briefly describes the capabilities of the Domino adapter.

The graphic below presents the communications between the participants of a request ona Domino R5 or R6 database. When the user performs a query, the ECI Services serveruses the power of Java and Corba-IIOP to handle the communication with Domino, andsend the results given back by Domino to the ECI Services client. The most importantthing to see is that ECI Services server has direct relation with the Domino server.

Figure 9-1. An ECI Services Query on Domino R5 or R6

Installation of the Domino ServerDomino Adapter makes remote calls to a Domino server; you must have access to thetarget Domino server. On the server, check the following points:

The server tasks HTTP and DIIOP must be running. Ensure that the server notes.inifile contains the following line:

ServerTasks=<any other tasks>,http,diiop

You can also start the tasks later with the load console command.

Example 9-1. Content of notes.ini File

…NAMEDSTYLE2_FACE=Default Sans SerifDefaultMailTemplate=mail50.ntf


Domino R5 and R6

ServerTasks=Router,Replica,Update,Amgr,AdminP,CalConn,Event,Sched,Stats,maps,http,diiopServerTasksAt1=Catalog,DesignServerTasksAt2=UpdAll,Object Collect mailobj.nsfServerTasksAt3=Object Info −Full

The server document in the Domino Directory (under Server\Servers) must permit andrestrict remote calls as desired:

Under Internet Protocols - IIOP, specify the number of threads to be allocated forhandling remote calls, or change the session timeout.

Figure 9-2. Domino Server Conguration Internet Protocols - IIOP

Under Ports - Internet Ports - DIIOP, set up the TCP/IP port for non-encrypted transfersand the SSL port for encrypted transfers. Indicate whether access is permitted by nameand password, and whether anonymous access is allowed.


Domino R5 and R6

Figure 9-3. Domino Server Conguration Ports - Internet Ports - DIIOP

Under Security - Server Access, fill in Access server, Not access server, Create newdatabases, and Create replica databases as desired.

Fill in Security - DIIOP Restrictions as desired.

Figure 9-4. Domino Server Conguration Security - Server Access and Security - DIIOP Restrictions

• A server refreshes its cache of security options approximately every half- hour. Theconsole command "tell diiop refresh" forces an immediate refresh.


Domino R5 and R6

• SSL security for CORBA-based Domino Objects applications/applets builds on theWeb Server SSL security. You must first set up the server security using the "DominoCertificate Authority" application.

Setting the Domino AdapterThe Notes documents have two kinds of information.

The first contains the fields of the database. They are chosen during the creation of thedatabase and are specific to your Domino server.

The second is common to every Domino server. It contains the state of the documentand its history. The following list shows some interesting attribute of this kind and theexisting association with ECI Services attributes.

Table 9-1. Association of Domino Attributes with ECI Services Attributes

Static attribute Description ECI Services attribute

Universal ID record_id

URL URL

Authors of the document co_authors, author, author1, author2,author3, author4, author5, author6,author7

Last modified date last_modified_date

Last accessed date last_accessed_date

Size of the document in bytes Size

Score of the document in the search Score

Universal ID of the parent view related_record_id

Owner of this document Owner

All the attributes contained in the Table are automatically extracted by the Dominoadapter.

For the attributes that depend on your Domino server, you imperatively have to specifythem in the list of mapout and mapin properties as it’s explained in the next section.

mapout.XX, mapin.XX : define the association of an ECI Services attribute with a field ofyour database.

Note: Always use “mapin.” and “mapout.” notation. Even if, ECI Services attribute hasthe same name than the field of your database. Otherwise this field wouldn’t be fetched.

How to Write the Property File

This section describes how to create the adapter backend on your ECI Services server.


Domino R5 and R6




<ECIS repository>/www/wrappers/core/DominoR5Backends

Create the entry for your backend in the domains.conf file. (Explained in theadministrator guide)


You can set other properties as described in the Administator’s guide. But the followinglist presents most common ones that can be changed for a Domino adapter.

bundle

• Description


• Value

core/DominoR5.jar

query

• Description

The list of primary attributes available for querying this source• Visible on client

Yes

result

• Description

The list of known attributes returned by this source• Visible on client

Yes


Domino R5 and R6

database

• Description

The name of the database you adapter. This is used by the ECI Services client tovisualize the results. What you’ve put in the ODBC driver configuration for "DataBase Name".

• value

(ex. notes databases samples/db1.nsf)

view

• Description

The name of the Notes view used by the ECI Services client to visualize the results.• value

(ex. EmpByLotus Notesame)

loginName

• Description



No

loginPassword

• Description



No


Domino R5 and R6

mapin.X

• Description

The list of mapin.X properties, explicits specifies how the remote source X attributeis translated in the internal ECI Services format.

e.g. mapin.library1.title=title

means that "library1.title" which will be received from the remote source will beadded in ECI Services as "title"

• value

mapout.X

• Description

The list of mapout.X properties, explicits specifies how the ECI Services X attribute istranslated in the source format.

e.g. mapout.date=table1.publication_date

means that "date" will be sent to the source as "table1.publication_date"• value• IMPORTANT

A query sent with an attribute not defined in the mapout list will not work.

DO NOT forget to define all the mapout properties, even if you have somethinglike this:

mapout.title=title

port

• Description

The port number of the HTTP server• Default value

80

image

• Description



Domino R5 and R6

• Default value


Yes

stopLimit

• Description

Exact number of result returns by this adapter.• Default value

50

Note: If requests on a Domino database are also processed on attachment files, thedatabase has to be indexed at least on its raw text attached files. Choose to alsoindex binary attachments if you want to be able to query binary documents (sample:*.doc documents).

As a sample, if queries have to be processed on the Inbox folder of a email database,set the view property as following, view = ($Inbox), and use the full-text property tosearch through attachment files.

Note: Within the Domain page, end users might supply their logins and passwordsto access a Domino information source. They must supply their “Web” accounts, nottheir “Notes” accounts.


Chapter 10Microsoft Site Server

The MS Site Server adapter enables the ECI Services client to query the MS Site Server in orderto consult indexed documents (such as MS Exchange public folders) and allows the final userto visualize the documents selected.

The communication between the ECI Services client and the ECI Services server is typical, i.e. . Thatis to say that the client builds the query, then submits it to the server which, and once the serverithas the answers from the source, it forwards them to the client.

The difference with other "typical adapters" is that the conversation between the ECI Services serverand the source documents (e. g. MS Exchange server) is not done performed directly, but through theMS Site Server.

The MS Site Server has two different roles: it first enables it to builds an index catalog of thedocuments to consult (such as MS Exchange public folders), then it allows enables the ECI Servicesserver to send a query in order to retrieve indexed data.

The MS Site Server can create index catalogs for three different document sources:• MS Exchange public folders• Documents contained in Web sites• Files stored in directories.To allow enable the final ECI Services user to visualize the documents, the ECI Services client uses thecapabilities of its hosting Web browser to visualize the documents through a direct communicationlink with the source documents.

Principles of the MS Site Server AdapterThis section briefly describes the capabilities of the adapter for the MS Site Server.

The Figure 10–1, page 78 figure presents the communication between the participantsof a request on a MS Exchange database. When the user performs makes a query, theECI Services server uses the MS Site Server to handle the communication with the MSExchange server, and sends the results given back to the ECI Services client. The mostimportant thing to see notice is that the ECI Services server has is not in no direct relationwith the MS Exchange server.

ECI Services script for MS Site Server


Microsoft Site Server

As a consequence of this architecture to query a database, the ECI Services server willuse its own ASP script stored in the MS Site Server. The MS Site Server will execute thisscript in order to obtain the query description and to consult the MS Exchange publicfolders. Then, tThis script will then retrieve the data extracted to the ECI Services server,and the ECI Services server will wrap the results and display them to the final user.

MS Site Server Index catalog

To be able to consult MS Exchange public folders, the MS Site Server uses index catalogs.As a consequence, the administrator of the MS Site Server must build these catalogsbefore the MS Exchange can be searched. Each catalog contains indexes for one or morepublic folders, and one ECI Services backend (configuration of a adapter bundle) mustbe set up for each catalog.

Let’s haveHere is an example:

First, the ECI Services script for the MS Site Server is stored in the Search directory ofthe MS Site Server.

To search in the MS Exchange for public folders named Folder1 and Folder2, the MSSite Server administrator has to build a catalog for these two folders: let’s name call itCatalog1

Then, the corresponding ECI Services adapter backend is configured to connect toCatalog1 of the MS Site Server: let’s name call it Backend1

FAnd finally, the final user can query ECI Services to wrap the MS Exchange publicfolders Folder1 and Folder2, using the appropriate backend Backend1.

Figure 10-1. An ECI Services Query on MS Exchange

Installation of the Microsoft Site Server

Installation of the MS Site Server

At this point, it is assumed that the MS Exchange server that you want to wrap isinstalled and that it is working. This section points to links describing how to install theMS Site Server required by the MS Exchange adapter.



Microsoft web pages for MS Site Server

A complete view of MS Site Server can be found at:

http://www.microsoft.com/siteserver/site/default.htm

White paper for MS Site Server installation

You can access the directly to Microsoft web site directly tofor have information on howto integrate MS Site Server with MS Exchange. Here is the HTML page where you candownload a compressed file containing a white paper for MS Site Server installation:

http://www.microsoft.com/SITESERVER/site/DeployAdmin/IntegrateExchange.htm

At the time this installation guide was being written, the white paper was named calledexchange.exe. This document first describes the configuration of the MS Exchange server,then the MS Site Server integration, and finally explains how to build index catalogs.

Here are some additional details that will enable you to find quickly the account that theMS Site Server should use for searchingto search the MS Exchange server:

1. Open MS Exchange Administrator

2. Below the site name (shown in the window title)

3. Click on Configuration

4. Open File ® Properties, select the Permission tab.

5. Find an account that has the ‘Service Account Admin’ role.

The MS Site Server should use this account to index and search the MS Exchangeserver.

Installation of the ECI Services Script for MS Site Server

Find the Search path of the MS Site Server

Open MS Site Server admin:

Start ® Programs ® Microsoft Site Server ® Administration ® Site Server ServiceAdmin (MMC)

Find the Search path:

In the left panel, click successively on Internet Info Server <Name of your server> DefaultWeb Sites Then right click on Site Server and select Properties The Local Path is indicatedin this panel.

Finally, the Search path is: <Local path>/Knowledge/Search

Install the ECI Services ASP script:

You can find the script at the following location:

<ECIS directory>/install/adapters/SiteServer/ECISSearch.asp

Copy the file ECISSearch.asp in the Search path of the MS Site Server.



Setting the MS Site Server Adapter

This section describes how to create the adapter backend on your ECI Services server.


This directory has to be over <ECIS Repository>/www/wrappers. You can choose to useone that already exists or to create your own.

Let’s say from now on that this directory is: <ECIS Repository>/www/wrappers/SiteServer.

Create the entry for your backend in the domains.conf file. (eExplained in theAadministrator’s Gguide). Add/create the configuration files for the new backend.

For each adapter at least two files are required:

(Let’s say we want to consult the MS Exchange public folder named called Folder1, thename of the backend file could be MsSExchangeFolder1.conf) MsSExchangeFolder1.confand MSsExchangeFolder1_en.properties.

If you are using a locale (je ne comprends pas ce mot, you must add the localizedproperties file likesuch as MsExchangeFolder1_fr.properties for the French locale.

You can set other properties as described in the Administrator’s Gguide. But tThefollowing list presents the most common ones properties that can be changed for on anMS Site Server adapter.

bundle

• Description


• Value

Core/SiteServer.jar

image

• Description


• Default value




Yes

host

• Description

The name of the server hosting the MS Site Server• Default value• Mandatory

Yes

port

• Description

The port number of the HTTP server• Default value

80

proxySet

• Description

Use the default HTTP proxy to access to MS Site Server (True/False)• Default value

True• Mandatory

No

catalog

• Description

The name of the MS Site Server catalog containing indexes to consult (e. g. theMS Exchange public folders to consult)


Yes



stopLimit

• Description

Maximum number of results returned by this adapter• Default value

50

query

• Description


Inherited from adapter bundle query=title,body,author,date,last_modified_date,full-text

• Mandatory


Yes

result

• Description


Inherited from adapter bundle result=title,URL,body,author,date,last_modified_date,size,score

• Mandatory


Yes


Chapter 11Sherlock

The Sherlock adapter enables the ECI Services client to use Sherlock 2 Plug-ins to search on theInternet. These plug-ins can be easily be found easily on the Internet, andthey are developed either byweb administrators or by web users. Their main purpose is to search , aiming at searching specificsites. One plug-in is dedicated to one site search.

A Sherlock plug-in describes how to query an Internet site, and how to gather results items from itspages. For each result, it typically enables to extracts the following attributes:• the title.• the associated URL associated.• the ‘body’ of the result (its description).Some other attributes can be extracted, depending on the information contained in the Sherlockplug-in:• Relevance• Price• Availability• Date• Last name• Email

Installing a Sherlock Plug-inTo install a Sherlock plug-in you should:

1. Download the plug-in from Internet

2. Uncompress the plug-in

3. Store it in the special Sherlock directory

4. Integrate it with the dedicated command

5. Update it when it is ‘broken’Download the plug-in from Internet

Locate and download the specific plug-in, and download it.

Uncompress the plug-in


Sherlock

Generally, the plug-init is compressed and you shouldneeds uncompressing it. Youshould obtain a text file with an ‘.src’ extension.

Note: If the file extension is ‘.sit’, then uncompress it with the Aladdin Expander. Here istThe URL where you can download the Aladdin Expander tool is as follows:

http://www.aladdinsys.com/expander/

Store the Sherlock plug-in in the special Sherlock directory

To be used with askOnce, aAll Sherlock plug-ins to be used with ECI Services (the fileswith the ‘.src’ extension) must be stored in the following special directory:

<ECIS directory>/www/wrappers/core/sherlockBackends/

Keep the original file name of the Sherlock plug-in, because as a different name couldraise generate conflicts when updating the plug-in.

Integrate it with the dedicated command

Once the Sherlock plug-in has been stored in the correctis directory, integrate theSherlock plug-it in by executing the dedicated command:

aOSherlockManager <Sherlock source file>

Where <Sherlock source file> is the name of the plug-in file that you have stored in theSherlock directory. Enter only the file name, with out no path name. The command willconsult directly the Sherlock directory and generate the adapter backend used by ECIServices. Three files are generated for the Sherlock backend:<Sherlock source file name>.conf<Sherlock source file name>_en.properties<Sherlock source file name>_fr.properties

Where <Sherlock source file name> is the name of the Sherlock source file stored in theSherlock directory.

Note: The <ECIS directory>/www/docs/conf/domains.conf file is automatically updated.

If you want to customize the Sherlock backend:• You can customize the description of this backend by editing the property

Description in the files with the ‘.properties’ extension.• You can specify the domain of this backend when executing the aOSherlockManager

command:

The option −dom <domain> specifies the domain of the backend. If this option is notpresent, then the domain is Sherlock. E.g. aOSherlockManager YahooSherlock.src−dom General If you create a new domain in the ECI Services domains root,then you will have to add its description in the configuration files: <ECISdirectory>/www/docs/conf/ domainDescription_XX.properties (aOSherlockManagerwarns you when such a new domain is created)

• You can specify the image property of this backend:

The option −im <image> specifies the image that will be displayed in the ECI Servicesuser interface (see the image property for all backends). If this option is not present,then the image property is sherlock. E.g. aOSherlockManager YahooSherlock.src−dom General −im yahoo


Sherlock

• To modify the domain or the image, simply just execute again the command againaOSherlockManager <Sherlock .src> −dom <domain> −im <image> with a newdomain and/or a new image.

All these settings are saved in the file SherlockProps.conf also stored in the Sherlockdirectory.

Update it when it is ‘broken’

See the next section.

Administrating Sherlock Plug-insTo update all Sherlock plug-ins you should:

1. Run the command: aOUpdaterThis tool enables to selects the backends associated to with the plug-ins, and toupdates them if a new version is available.

2. Run the command: aOSherlockManager −monitorThis commandIt will regenerate all the backends associated to with the Sherlockplug-ins contained in the Sherlock directory (<ECIS directory>/www/wrappers/core/sherlockBackends/).

Creating Sherlock Plug-insVisit the Apple site pages dedicated to Sherlock 2:

http://www.apple.com/sherlock/

You will find plug-ins, and reference documents that describe how Sherlock plug-inscan be created.

Sherlock Backend PropertiesHere are the properties contained in each Sherlock backend that you could may needto modify:

Image

This property should only be set only using the aOSherlockManager command, seeInstalling a Sherlock Plug-in, page 83

• Description


Sherlock


• Default value


Yes

stopLimit

• Description

Maximum number of results returned by this adapter• Default value

50


Chapter 12Connect to a Source Using HTTPS

HTTPS is a secured version of the HTTP protocol. This protocol requires authentication of the remotesource before connection is done; it ensures that no other party can intercept or modify the databetween ECI Services and the remote source.

To use HTTPS, the remote source must be HTTPS compliant. So it must propose web pages forwhich the URL starts with “https://” instead of the standard “http://”. In this case use the followingsteps to configure the adapter.

For this section the following example will be studied: https://www.safeweb.com/products.html

Congure the Adapter with HTTPSFor the whole developement environment configuration, refer to the section 2 to knowhow to install the template files.

Open the adapter configuration file (Safeweb.conf) and set the properties:• host=www.safeweb.com• port=443• For https protocol the default port is equal to 443 !• proxySet=true

Note: When you are going through a proxy to access the remote source, make surethat your proxy is well configured to accept SSL connection.

• action=/products.html• method=get• protocol=https

Note: This property declares that the adapter uses https to connect to the remotesource.

Note: Various protocols can be used for different levels by setting the propertyprotocol<X> where X is the value of the level. For example:• protocol=http• protocol1=httpsThese properties declare that globally the protocol to use is http, except for the level 1page for which the https protocol will be used.


Connect to a Source Using HTTPS

Try to Wrap the Remote SourceOnce the adapter is configured (at least with the host, action and protocol properties),use aOAdapterTester to check if it can connect to the remote source.

For example:{aO install dir}\bin\aOAdapterTester −n training/Safeweb −a full-text −q test

If the adapter fails and the following error message is printed within the trace:“javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated”

then the remote source owns a certificate that is not trusted by ECI Services. In this caseread the next section to add the certificate to the ECI Services certificate store.

Otherwise if the adapter succeeds, or fails with another error message, then the httpsconnection is correct. When you’re using a proxy the message could be the one of thislater.

Note: A special value can be set for the protocol or protocolX properties:protocol=https-no-auth

This value declares that the ECI Services server must NOT ask for the remote source toauthenticate itself. In this case the https security is no more ensured, but in the otherhand there is no need to know (e.g. trust) the remote source certificate. Use this specialvalue with special care.

Check the Remote Source CerticateTo be accessed with HTTPS, the remote source must own a certificate that authenticatesitself. The ECI Services server must also know and trust this certificate for the connectionto be established.

By default, the ECI Services server consults a certificate store file that describes thetrusted certificates: <aO install dir>/www/docs/conf/trustedCerts.cer

The default certificate store file can be eventually copied in another file so as to use thenew file as a custom certificate store. Several properties can be set in the <aO installdir>/www/docs/conf/server.conf file to select other certificate store files, see the propertyxtrim.ssl.trustStore.

The following steps describe how to add a new certificate in the ECI Services certificatestore file:

Save the Remote Source Certicate

Open Microsoft Internet Explorer and enter the url of the remote source. The url muststarts with “https” (e.g. https://www.safeweb.com) A security alert message box mayappear to inform that a secured web page is about to be viewed. Accept the message.



If the web page of the remote source is correctly displayed, then the remote certificateis already known by Internet Explorer, right click on the page and select Propertiesthen Certificates.

Note: The Certification Path information, close the window and go directly to the step4. Else a message box is displayed warning that the certificate of the remote source isnot trusted, then click on View certificate.

Click on Install Certificate… An installation wizard is displayed, choose to let itautomatically select the certificate store and finish.

Stay in Internet Explorer and open the menu: Tools ® Internet Options Select theContent tab and then Certificates… Select the appropriate tab corresponding to thestore noted in the previous step (Other People in the example) Select the certificate inthe list by looking for its name.

Click on Export… button to save the certificate in a separate file. A certificate exportwizard is displayed. For the format of the certificate file, choose DER encoded binaryX.509 or Base-64 encoded X.509. Browse in the directories and create a new certificatefile. Let’s call it safeweb.cer in this example. Save it in <aO install dir>/www/docs/confrepository. Finish the wizard, the file is created, and close the windows. The remotesource certificate has been saved, now the last step is to add it to the ECI Services trustedcertificates store.

Add the Certicate to ECI Services Keystore File

The default ECI Services trusted certificates keystore file is <aO installdir>/www/docs/conf/trustedCerts.cer. This store file can be managed with the Java™utility keytool located in <aO install dir>/_jvm/bin/keytool.exe.

For more information refer to javadoc of the jdk installed on your machine.

If necessary move the remote source certificate file (created in the previous section) in thedirectory <aO install dir>/www/docs/conf.

Open a dos console (menu Start->Run ... cmd), go to this directory and type thefollowing command:

<aO install dir>/_jvm/bin/keytool −import −alias <my alias> -file <my certificate>-keystore <my keystore file>

where:

<aO install dir> is the directory in which ECI Services is installed.

<my alias> is an alias choosen for the certificate. Any name can be choosen, type one thatmakes remember which certificate is associated.

<my certificate> is the name of the certificate file (created in the previous section).

<my keystore file> is the name of file that contains all the certificates for the trustedremote sources (e.g. trustedCerts.cer which is the default trusted certificates keystore filefor ECI Services). It can be replaced by any other certificate keystore file.

For example:



<aO install dir>/_jvm/bin/keytool −import −alias safeweb −file safeweb.cer −keystoretrustedCerts.cer

The password of the trustedCerts store is: changeit

The keytool utility asks to confirm the addition of the new certificate, type yes.

The new certificate to trust is added, now just check that the adapter can connect tothe remote source.

Note: The keytool utility provides other commands to manage certificates stores.One of them enables to list the certificates of the store. In the directory <aO installdir>/www/docs/conf, type the command <aO install dir>/_jvm/bin/keytool −list -keystoretrustedCerts.cer with the password: changeit.


Index

Aaction, 18, 41, 45

AX 4 and 5, 45eRoom 7 adapter, 41

action1, 51Docushare, 51

action2Docushare, 51

actionX, 18adapter

bundles, 14adapter backend

configuring for JDBC/ODBCadapter, 59

adapters, 13add the certificate to ECI Services keystore

fileHTTPS, 89

administering the plug-inSherlock, 85

agent, 56Docushare, 56

applicationFields, 46AX 4 and 5, 46

applicationName, 45AX 4 and 5, 45

attributes, 37Documentum adapter, 37

AX 4, 43AX 4 and 5

action, 45applicationFields, 46applicationName, 45bundle, 44host, 44login_action, 45loginName, 45mapin.X, 46mapout.X, 46principles, 43

setting the adapter, 43AX 5, 43

Bbackend properties

Sherlock, 85backends, 14baseName, 31

Documentum adapter, 31bundle, 16, 30, 40, 44, 49, 60, 73, 80

AX 4 and 5, 44Documentum adapter, 30Docushare, 49Domino R5 and R6 adapter, 73eRoom 7 adapter, 40JDBC/ODBC adapter, 60Microsoft Site server, 80

bundlesadapter, 14

Ccatalog, 81

Microsoft Site server, 81check the remote source certificate

HTTPS, 88client.* properties, 28client.overview, 27client.resultIcon, 28Collection.ViewCommand, 53

Docushare, 53common backend configuration

action, 18actionX, 18bundle, 16client.* properties, 28client.overview, 27client.resultIcon, 28dateFormat, 25duplicate, 22


Index

duplicateKey, 22encoding, 25expirationTime, 22file properties, 15filter, 21home, 17host, 16image, 27location, 27loginName, 19loginPassword, 20maxSubsumedQueries, 26method, 18methodX, 19modificationKey, 23port, 16protocol, 17protocolX, 17proxySet, 20query, 20queryLanguage, 24result, 21stopLimit, 21strategy, 25supportsLogin, 19supportsSubsumption, 26supportsUpdate, 24trusted, 26updateURL, 24

configure the adapterHTTPS, 87

configuringadapter backend for JDBC/ODBC

adapter, 59DFC, 29DocBroker, 29

configuring the adapter backendOracle, 67

connecting to a source using HTTPS, 87constraint, 32

Documentum adapter, 32creating plug-ins

Sherlock, 85CustomFields, 42

eRoom 7 adapter, 42

Ddatabase, 74

Domino R5 and R6 adapter, 74

database driversinstallation and configuration, 58

dateFormat, 25dateOutputFormat, 64

JDBC/ODBC adapter, 64debug, 54

Docushare, 54DFC

configuring, 29setup, 29

direct JDBC driverusing, 59

DMCLsetup, 30

DocBrokerconfiguring, 29

docType, 32Documentum adapter, 32

Documentum adapterattributes, 37baseName, 31bundle, 30constraint, 32docType, 32filter, 33host, 31image, 30location, 33loginName, 31loginPassword, 31map.full-text, 36mapin.<Documentum attributes>, 35mapmerge, 35mapmerge.<ECIS attributes>, 36mapout.<ECIS attributes>, 35port, 31preferredRendition, 34proxySet, 37query, 33result, 34secondaryRendition, 34setting, 30stopLimit, 32supportsLogin, 32trusted, 33useFTI, 33

Docushare, 49action1, 51action2, 51agent, 56


Index

bundle, 49Collection.ViewCommand, 53debug, 54failOnNetworkError, 55File.ViewCommand, 52host, 50image, 54loginName, 53loginPassword, 53map.full-text, 55port, 50proxySet, 50query, 51result, 52setting up adapter, 49startFrom, 52useFTI, 54User.ViewCommand, 52virtualDir, 50

Domino R5, 69Domino R5 and R6

installing the server, 69principles, 69setting the adapter, 72writing the property file, 72

Domino R5 and R6 adapterbundle, 73database, 74image, 75loginName, 74loginPassword, 74mapin.X, 75mapout.X, 75port, 75query, 73result, 73stopLimit, 76view, 74

Domino R6, 69duplicate, 22duplicateKey, 22

EECI Services script for eRoom

installing, 39encoding, 25endClause, 62

JDBC/ODBC adapter, 62eRoom 7, 39

eRoom 7 adapteraction, 41bundle, 40CustomFields, 42eRoomName, 41facilityName, 41host, 40loginName, 41

eRoom adapterprinciples, 39

eRoom AdapterSetting, 40

eRoomName, 41eRoom 7 adapter, 41

expirationTime, 22

FfacilityName, 41

eRoom 7 adapter, 41failOnNetworkError, 55

Docushare, 55file properties

action, 18actionX, 18bundle, 16client.* properties, 28client.overview, 27client.resultIcon, 28common backend configuration, 15dateFormat, 25duplicate, 22duplicateKey, 22encoding, 25expirationTime, 22filter, 21home, 17host, 16image, 27location, 27loginName, 19loginPassword, 20maxSubsumedQueries, 26method, 18methodX, 19modificationKey, 23port, 16protocol, 17protocolX, 17proxySet, 20


Index

query, 20queryLanguage, 24result, 21stopLimit, 21strategy, 25supportsLogin, 19supportsSubsumption, 26supportsUpdate, 24trusted, 26updateURL, 24

File.ViewCommand, 52Docushare, 52

filter, 21, 33Documentum adapter, 33

fromClause, 62JDBC/ODBC adapter, 62

Hhome, 17host, 16, 31, 40, 44, 50, 81

AX 4 and 5, 44Documentum adapter, 31Docushare, 50eRoom 7 adapter, 40Microsoft Site server, 81

HTTPSadd the certificate to ECI Services

keystore file, 89check the remote source certificate, 88configure the adapter, 87connecting to a source, 87save the remote source certificate, 88wrap the remote source, 88

IignoreCase, 65

JDBC/ODBC adapter, 65image, 27, 30, 54, 64, 75, 80

Documentum adapter, 30Docushare, 54Domino R5 and R6 adapter, 75JDBC/ODBC adapter, 64Microsoft Site server, 80

Image, 85Sherlock, 85

installation and configurationdatabase drivers, 58

installing

Domino R5 and R6 server, 69ECI Services script for eRoom, 39Microsoft Site server, 78

installing plug-inSherlock, 83

installing the ECI Services scriptMicrosoft Site server, 79

JJDBC, 57JDBC/ODBC adapter

bundle, 60dateOutputFormat, 64endClause, 62fromClause, 62ignoreCase, 65image, 64jdbcDriver, 61jdbcUrl, 61keyAttribute, 63likeMode, 63mapin.X, 64mapout.X, 65principles, 57query, 60query.enclosingDate, 64result, 60result.enclosingChar, 63selectClause, 62trusted, 61useToDate, 63whereClause, 62

JDBC/ODBC bridgeusing, 59

jdbcDriver, 61JDBC/ODBC adapter, 61

jdbcUrl, 61JDBC/ODBC adapter, 61

KkeyAttribute, 63

JDBC/ODBC adapter, 63

LlikeMode, 63

JDBC/ODBC adapter, 63location, 27, 33

Documentum adapter, 33


Index

login_action, 45AX 4 and 5, 45

loginName, 19, 31, 41, 45, 53, 74AX 4 and 5, 45Documentum adapter, 31Docushare, 53Domino R5 and R6 adapter, 74eRoom 7 adapter, 41

loginPassword, 20, 31, 53, 74Documentum adapter, 31Docushare, 53Domino R5 and R6 adapter, 74

Mmap.full-text, 36, 55

Documentum adapter, 36Docushare, 55

mapin.<Documentum attributes>, 35Documentum adapter, 35

mapin.X, 46, 64, 75AX 4 and 5, 46Domino R5 and R6 adapter, 75JDBC/ODBC adapter, 64

mapmerge, 35Documentum adapter, 35

mapmerge.<ECIS attributes>, 36Documentum adapter, 36

mapout.<ECIS attributes>, 35Documentum adapter, 35

mapout.X, 46, 65, 75AX 4 and 5, 46Domino R5 and R6 adapter, 75JDBC/ODBC adapter, 65

maxSubsumedQueries, 26method, 18methodX, 19Microsoft Site server, 77

bundle, 80catalog, 81host, 81image, 80installing, 78installing the ECI Services script, 79port, 81principles, 77proxySet, 81query, 82result, 82setting the adapter, 80

stopLimit, 82modificationKey, 23

OODBC, 57Oracle, 67

configuring the adapter backend, 67

Pport, 16, 31, 50, 75, 81

Documentum adapter, 31Docushare, 50Domino R5 and R6 adapter, 75Microsoft Site server, 81

preferredRendition, 34Documentum adapter, 34

principlesAX 4 and 5, 43Domino R5 and R6, 69JDBC/ODBC adapter, 57Microsoft Site server, 77

property fileDomino R5 and R6, 72

protocol, 17protocolX, 17proxySet, 20, 37, 50, 81

Documentum adapter, 37Docushare, 50Microsoft Site server, 81

Qquery, 20, 33, 51, 60, 73, 82

Documentum adapter, 33Docushare, 51Domino R5 and R6 adapter, 73JDBC/ODBC adapter, 60Microsoft Site server, 82

query.enclosingDate, 64JDBC/ODBC adapter, 64

queryLanguage, 24

Rresult, 21, 34, 52, 60, 73, 82

Documentum adapter, 34Docushare, 52Domino R5 and R6 adapter, 73JDBC/ODBC adapter, 60


Index

Microsoft Site server, 82result.enclosingChar, 63

JDBC/ODBC adapter, 63Root

Server, 14

Ssave the remote source certificate

HTTPS, 88secondaryRendition, 34

Documentum adapter, 34selectClause, 62

JDBC/ODBC adapter, 62Server

Root, 14setting

Documentum adapter, 30Setting

eRoom Adapter, 40setting the adapter

AX 4 and 5, 43Domino R5 and R6, 72Microsoft Site server, 80

setting up adapterDocushare, 49

setupDFC, 29DMCL, 30

Sherlock, 83administering the plug-in, 85backend properties, 85creating plug-ins, 85Image, 85installing plug-in, 83stopLimit, 86

startFrom, 52Docushare, 52

stopLimit, 21, 32, 76, 82, 86Documentum adapter, 32Domino R5 and R6 adapter, 76

Microsoft Site server, 82Sherlock, 86

strategy, 25supportsLogin, 19, 32

Documentum adapter, 32supportsSubsumption, 26supportsUpdate, 24

Ttrusted, 26, 33, 61

Documentum adapter, 33JDBC/ODBC adapter, 61

UupdateURL, 24useFTI, 33, 54

Documentum adapter, 33Docushare, 54

User.ViewCommand, 52Docushare, 52

useToDate, 63JDBC/ODBC adapter, 63

usingdirect JDBC driver, 59JDBC/ODBC bridge, 59

Vview, 74

Domino R5 and R6 adapter, 74virtualDir, 50

Docushare, 50

WwhereClause, 62

JDBC/ODBC adapter, 62wrap the remote source

HTTPS, 88


© 2011 - 2013 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change

without

notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO

REPRESENTATIONS OR

WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND

SPECIFICALLY

DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

EMC2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United State and other

countries.

All other trademarks used herein are the property of their respective owners.