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

Enterprise Content IntegrationServices Adapter Installation Guide

Version 5.3 SP2April 2006

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-2006 EMC Corporation. All rights reserved.

Table of Contents

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

Chapter 1 Introduction ........................................................................................... 11A few terms explained ................................................................................ 12Adapters................................................................................................ 12Adapter bundles..................................................................................... 12Backends ............................................................................................... 12

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

Enterprise Content Integration Services Adapter Installation Guide 3

Table of Contents

image ........................................................................................................ 25location...................................................................................................... 26client.overview ........................................................................................... 26client.resultIcon .......................................................................................... 27client.* properties ....................................................................................... 27client.dfc.types ........................................................................................... 27

Chapter 3 Common ECI Attributes ......................................................................... 29source ........................................................................................................ 29score .......................................................................................................... 30title............................................................................................................ 30URL........................................................................................................... 30date ........................................................................................................... 31body .......................................................................................................... 31abstract ...................................................................................................... 31author........................................................................................................ 32keyword .................................................................................................... 32format........................................................................................................ 32size ............................................................................................................ 33rank........................................................................................................... 33

Chapter 4 Documentum ECM 5.3 ........................................................................... 35Setting the Documentum adapter ................................................................ 35bundle ................................................................................................... 35image .................................................................................................... 36baseName .............................................................................................. 36host ....................................................................................................... 36port ....................................................................................................... 37loginName ............................................................................................. 37loginPassword........................................................................................ 37supportsLogin ........................................................................................ 37docType ................................................................................................. 38constraint............................................................................................... 38stopLimit ............................................................................................... 38filter....................................................................................................... 38trusted ................................................................................................... 39useFTI ................................................................................................... 39location.................................................................................................. 39viewUrl ................................................................................................. 39query ..................................................................................................... 40result ..................................................................................................... 40preferredRendition ................................................................................. 40secondaryRendition................................................................................ 41mapout.<ECIS attributes>........................................................................ 41mapin.<Documentum attributes> ............................................................ 41mapmerge.............................................................................................. 42mapmerge.<ECIS attributes> ................................................................... 42map.full-text .......................................................................................... 43attributes ............................................................................................... 43proxySet ................................................................................................ 44

Chapter 5 eRoom 7 ................................................................................................ 45

4 Enterprise Content Integration Services Adapter Installation Guide

Table of Contents

Principles of the eRoom adapter .................................................................. 45Installation of the ECI Services script for eRoom ........................................... 45Setting the eRoom adapter .......................................................................... 46bundle ................................................................................................... 47host ....................................................................................................... 47action..................................................................................................... 47facilityName .......................................................................................... 48eRoomName .......................................................................................... 48loginName ............................................................................................. 48CustomFields ......................................................................................... 49

Chapter 6 AX 4 and 5 ............................................................................................. 51Principles of the AX adapter........................................................................ 51Setting the AX adapter ................................................................................ 51bundle ................................................................................................... 52host ....................................................................................................... 53action..................................................................................................... 53login_action ........................................................................................... 53applicationName .................................................................................... 53loginName ............................................................................................. 54

applicationFields ........................................................................................ 54mapin.X ..................................................................................................... 54mapout.X ................................................................................................... 55

Chapter 7 EmailXtender 4.7 ................................................................................... 57Principles of the EmailXtender adapter ........................................................ 57The ECIS_Adapter_EmailXtender.zip file ..................................................... 57Setting the EmailXtender runtime DLLs ....................................................... 58EmailXtender server settings ....................................................................... 58EmailXtender adapter settings..................................................................... 61action..................................................................................................... 62bundle ................................................................................................... 62VirtualDownloadPath ............................................................................. 62PhysicalDownloadPath ........................................................................... 63download_url ........................................................................................ 63exserver ................................................................................................. 63home ..................................................................................................... 64host ....................................................................................................... 64image .................................................................................................... 64protocol ................................................................................................. 65query ..................................................................................................... 65result ..................................................................................................... 66stopLimit ............................................................................................... 66

ECI attributes for EmailXtender................................................................... 66Operators............................................................................................... 66Examples ............................................................................................... 67

Chapter 8 JDBC/ODBC Adapter ............................................................................. 69Principles of the JDBC/ODBC adapter .......................................................... 69Installation and configuration of the database drivers ................................... 70Using the JDBC/ODBC bridge ................................................................. 70Using a Direct JDBC driver...................................................................... 71

Configuration of the adapter backend .......................................................... 71


Table of Contents

bundle ................................................................................................... 71query ..................................................................................................... 72result ..................................................................................................... 72trusted ................................................................................................... 72jdbcDriver.............................................................................................. 73jdbcUrl .................................................................................................. 73selectClause ........................................................................................... 73fromClause ............................................................................................ 74whereClause .......................................................................................... 74endClause .............................................................................................. 74useToDate .............................................................................................. 74likeMode................................................................................................ 75keyAttribute........................................................................................... 75result.enclosingChar ............................................................................... 75image .................................................................................................... 76dateOutputFormat.................................................................................. 76query.enclosingDate ............................................................................... 76mapin.X ................................................................................................. 77mapout.X ............................................................................................... 77useFTI ................................................................................................... 77map.full-text .......................................................................................... 78

Chapter 9 Sherlock ................................................................................................ 79Installing a Sherlock plug-in ........................................................................ 79Administrating Sherlock plug-ins ................................................................ 81Creating Sherlock plug-ins .......................................................................... 81Sherlock backend properties........................................................................ 82Image .................................................................................................... 82stopLimit ........................................................................................... 82

Chapter 10 Connecting to a Source Using HTTPS ................................................... 83Configuring the adapter with HTTPS........................................................... 83Wrapping the remote source........................................................................ 84Checking the remote source certificate ......................................................... 84Saving the remote source certificate ......................................................... 85Adding the certificate to ECI Services keystore file.................................... 86


Table of Contents

List of Figures

Figure 5–1. IIS server configuration ................................................................................... 46Figure 7–1. The temp folder properties — HTTP Headers tab ............................................. 59Figure 7–2. Mime Types dialog box ................................................................................... 60Figure 7–3. New MIME Type dialog box............................................................................ 60Figure 7–4. IIS server setup — Active Server Pages option .................................................. 61Figure 8–1. An ECI Services query on JDBC....................................................................... 69Figure 8–2. An ECI Services query on ODBC ..................................................................... 70


Table of Contents

List of Tables

Table 3–1. source ............................................................................................................ 29Table 3–2. score .............................................................................................................. 30Table 3–3. title................................................................................................................ 30Table 3–4. URL............................................................................................................... 30Table 3–5. date ............................................................................................................... 31Table 3–6. body .............................................................................................................. 31Table 3–7. abstract .......................................................................................................... 31Table 3–8. author............................................................................................................ 32Table 3–9. keyword ........................................................................................................ 32Table 3–10. format............................................................................................................ 32Table 3–11. size ................................................................................................................ 33Table 3–12. rank............................................................................................................... 33Table 7–1. action............................................................................................................. 62Table 7–2. bundle ........................................................................................................... 62Table 7–3. VirtualDownloadPath ..................................................................................... 62Table 7–4. PhysicalDownloadPath ................................................................................... 63Table 7–5. download_url ................................................................................................ 63Table 7–6. exserver ......................................................................................................... 63Table 7–7. home ............................................................................................................. 64Table 7–8. host ............................................................................................................... 64Table 7–9. image ............................................................................................................ 64Table 7–10. protocol ......................................................................................................... 65Table 7–11. query ............................................................................................................. 65Table 7–12. result ............................................................................................................. 66Table 7–13. stopLimit ....................................................................................................... 66Table 7–14. Example......................................................................................................... 67


Preface

Enterprise Content Integration (ECI) Services provides the following content integration features:• Multi-repository searches• Search capabilities within external repositoriesECI Services, along with a number of other Documentum products, provides a number of features.They are as follows:• 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 since DCTM 5.3 through an extended search capability withinWebtop. By integrating ECI Services into the Documentum Platform, all WDK-based Documentumsolutions have access to ECI features. All WDK-based applications (Webtop, WDK for Portlets, DAM,DCM, WP, and so on) are now able to take advantage of the ECI features previously stated. Userscan 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,


Preface

the librarian working in ACME Corporation could create an “ACME” domaincontaining only local backends, and specifically the local MIS backend configured bythe administrator.

These configuration tasks should always be performed using the Admin Center. Thesection 4.1 of the ECI Services Administration Guide describes briefly the principles ofthe tool and how to connect to its web interface. This document contains references toconfiguration files and the possibility to edit them. Such a manual configuration shouldonly be performed by experienced administrator for troubleshooting 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

January 2006 Initial release

April 2006 Removed the chapter OracleAdded the details of the viewUrl property inthe chapter Documentum ECM 5.3


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• Oracle8i and later• JDBC/ODBC• Sherlock 2, internet search plug-insThis document assumes that you have 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.


Introduction

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.Adapters are delivered in the form of adapter bundles. For instance, an adapterdeveloper would develop an adapter bundle for the Microsoft Index Server searchengine.

Adapter bundles

Adapters are delivered in the form of adapter bundles. An adapter bundle is 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 an 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.


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 Lotus Notes server). Abackend is defined by creating a file with the name pattern: <Backend Name>.conf and placing itin the same directory as the adapter bundle. The properties defined in the local configuration filewill then override the default values from the bundle, creating a tailored backend fitting the needs ofthe local system. A typical backend file is given in the example Typical content of the backend file“AcmeDocumentum.conf”, page 13.

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

Example 2-1. Typical content of the backend le “AcmeDocumentum.conf”

bundle=core/DocumentumFC.jarhome=http://www.documentum.comimage=documentum

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

bundle• Description


Common Backend Conguration File Properties

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

for example. 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 disable theremote source authentication with https, use the value: https-no-auth. For example,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.For example, 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, for example,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. (for example,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.(for example, 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. (forexample, 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

No



• Visible on client

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

Inherited from adapter bundle• Mandatory


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, for example,“ISBN”. By default, when this attribute is absent, results are identified by their’URL’ attribute. But some sources generate different URLs for the same result acrossseveral invocations. In this case this property enables to use a special attributeinstead of URL 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’ areisidentical. 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> for example, modificationKey=(date)last_modified_date Theresult with the more recent date is retained (and additional attributes from the otherresults are merged, if they exists)

Compare the version attribute modificaactionKey=(version)<name of the attributethat contains an integer> for example, modificationKey=(version)version_numberThe result with the highest version number is retained (and additional attributesfrom the other results are merged, if they exists)

• Default value

All attributes• Mandatory


Yes

queryLanguage * (optional)• Description



Indicates the language used to query the source.

for example, 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



• Visible on client

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 of thisproperty is “ACME” (for example, 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.

client.dfc.types• Description

Instructs Webtop that an external source supports some doctypes or can be safelysearched using the attributes of some doctypes.

Example 2-2. ExampleYou need to add the following in the adapter configuration file (.conf):



client.dfc.types=doctype1,doctype2


Chapter 3Common ECI Attributes

A common adapter configuration is used to define a meta-data mapping between object fields in asource and ECI attributes. A good example is the properties named mapout.XXX and mapin.YYY forthe Documentum adapter.

It is very important to use common ECI attributes when possible in your adapter. In ECI, a query notonly searches using its adapter, but also using other adapters to provide its result set. Therefore, alladapters should share meta data. They should use common ECI attributes when possible, so that asearch on title in ECI is handled consistently. For example, search on source A where the meta datais named heading and on source B where meta data is named object_name will be consistent ifmeta data is shared.

Common ECI attributes have been inspired by the “Dublin Core Metadata Element Set: ReferenceDescription”. Some of the attributes are used for building the result display in various ECI clients.Therefore, they are listed in this section.

A comprehensive list of ECI attributes is available from the attributes localization file.The default location of the file is C:\Program Files\Documentum\eci\www\docs\conf\attributesDescription_en.properties.

sourceTable 3-1. source

Descrip-tion

Name of the backend that returns the result.

Visible on Webtop, Discovery Manager, and Portlet.It is displayed as the result origin in Webtop (similar to the path of aresult returned by a Documentum repository). It is displayed in themiddle column of other clients result list.

Reserved This attribute is created by ECI and must not be generated by the adapter.


Common ECI Attributes

scoreTable 3-2. score

Descrip-tion

Indicates the relevance of the result based on the source criteria. If therating is closer to 100%, the result matches your query better.

Visible on Webtop, Discovery Manager, and PortletIt is displayed as the score column in Webtop and other clients result list.

Reserved This attribute is created by ECI and must not be generated by the adapter.

Format A percentage (without the ‘%’ unit sign)

titleTable 3-3. title

Descrip-tion

Name assigned to the resource.

Visible on Webtop, Discovery Manager, and PortletIt is displayed as object_name in Webtop and as the Title column in otherclients result list.

URLTable 3-4. URL

Descrip-tion

Contains a hypertext link or an internet address where the resource canbe found.

Visible on Webtop, Discovery Manager, and PortletIt is a link on the title in all clients result list.

Format A valid URL syntax



dateTable 3-5. date

Descrip-tion

Date on which the resource was made available.

Visible on Webtop, Discovery Manager, and Portlet.It is displayed as r_modify_date in Webtop and as the end of middlecolumn in other clients result list.

Format ISO 8601 format (2004-05-21, yyyy-MM-dd)

bodyTable 3-6. body

Descrip-tion

Represents the content (full or partial) of the resource.

Visible on Webtop, Discovery Manager, and Portlet.It is displayed as summary in Webtop and as the default content of themiddle column in other clients result list.

abstractTable 3-7. abstract

Descrip-tion

A textual description of the content of the resource.

Visible on Discovery Manager and PortletIt is displayed as the default content of the middle column in the resultlist.



authorTable 3-8. author

Descrip-tion

Person(s) or organization(s) primarily responsible for the intellectualcontent of the resource.

Visible on WebtopIt is displayed as authors in Webtop.

keywordTable 3-9. keyword

Descrip-tion

To search among a predefined keywords list.

Visible on Webtop Displayed as keywords in Webtop.

formatTable 3-10. format

Descrip-tion

Physical or digital manifestation of the resource.

Visible on WebtopIt is displayed as a_content_type in Webtop.

Format A valid MIME type syntax



sizeTable 3-11. size

Descrip-tion

Represents the document size (usually in KBytes).

Visible on Webtop.Displayed as r_full_content_size in Webtop.

Format Kilobytes (just the figure, no unit)

rankTable 3-12. rank

Descrip-tion

Indicates the relevance of the result according to the source criteria. If therank is closer to 1, the result matches your query better.

Visible on Webtop.It is displayed as rank in Webtop.

Format Integer

Note: Any attribute with its name suffixed with “_date” is converted to the ECI/Webtopdate format.


Chapter 4Documentum ECM 5.3

The purpose of the Documentum adapter is not only to allow the ECI Services client to query aDocumentum repository 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 repository is performed using the DocumentumDFC library. The DFC is based on the native DMCL library. 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.

Note: The Documentum adapter does not require the DFC to be pre-installed on the ECI Servicesserver. ECI Services comes with its own set of DFC components.

Setting the Documentum adapterLog in to the ECI Services Admin Center, visit the domains page, and then click Addto create a backend configuration for your repository. The configuration wizard willhelp you with the setup of the backend. As an alternative, you can 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


Documentum ECM 5.3

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

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

Yes

baseName

• Description

The name of the repository to connect to (for example dm_my_repository)• 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


Documentum ECM 5.3

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

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 repository.• 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


Documentum ECM 5.3

docType

• Description

The name of the Documentum collection you perform the search. It should be asubtype of dm_sysobject (for 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

lter

• Description

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

• Default value

Default value


Documentum ECM 5.3

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 repository has a working full-text Index that you want to use forsearch on the ‘full-text’ attribute. If it is set to true do not forget to add ‘body’ in thelist 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

viewUrl

• Description

URL redirection: Set a webtop base URL value to redirect the document request tothe webtop, that is, build a fixed URL instead of viewing document from the ContentServer (through DFC). With viewURL set, each document URL will be:

’<viewURL>’+<objectId>’


Documentum ECM 5.3

Example:

http://webtophost/webtop/drl/objectId/0900584a80001398 with viewUrl=http://<machine name>:<port>/webtop/drl/objectId/

• Default value

None• Visible on client

No

query

• Description

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.


Documentum ECM 5.3

The rendition corresponds to the name of the format in the repository: 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 repository: msw8 (forWord), pdf, text.

• Default value

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 4-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>


Documentum ECM 5.3

Example 4-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 4-3. Syntax

mapmerge=<ECIS attribute names>

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

mapmerge.<ECIS attributes>

• Description

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

Example 4-4. Syntax

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

Example 4-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


Documentum ECM 5.3

‘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 4-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’.


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.


Documentum ECM 5.3

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


Chapter 5eRoom 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

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

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

For example, c:\Inetpub\scripts\ECISAdapter

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


eRoom 7

4. Create an alias for the IIS Server on this directory, with read and script access rights(see the following figure).

For example, ECISadapter

Figure 5-1. IIS server conguration

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

1. Choose a host repository for your backend.

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

For example, the directory is: <ECIS repository>/www/wrappers/portal/eroomBackends.

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


eRoom 7

3. Add/create the configuration files for the new backend.

For each adapter, at least two files are required.

For example, if we want to consult the eRoom called Folder1, the name of the backendfile could be eRoomFolder1.conf. Therefore, the two files are eRoomFolder1.conf andeRoomFolder1_en.properties.

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

5. You can set other properties as described in the Administrator’s Guide. The followinglist presents the most common properties that can be changed for 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

Yes

action

• Description


eRoom 7

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

For example, 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’.

For example, 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 ’,’

For example, 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.

For example, customFields=birth-city,temperature,birth_date

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

No


eRoom 7


Chapter 6AX 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.

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.

1. Choose a host repository for your backend.

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

For example, the directory is: <ECIS repository>/www/wrappers/core/AXbackends.


AX 4 and 5

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

3. Add/create the configuration files for the new backend.

For each adapter, at least two files are required.

For example, if we want to consult the AX application called application1, thename of the backend file could be AXApplication1.conf. Therefore, the two files areAXApplication1.conf and AXApplication1_en.properties.

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

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

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

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


AX 4 and 5

host

• Description

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

Yes

action

• Description

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

For example, /IEciResultSet.asp• Default value• Mandatory

Yes

login_action

• Description

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

For example, /login.asp• Default value• Mandatory

Yes

applicationName

• Description

The AX application to be searched.

For example, applicationName=MYAPPLICATION


AX 4 and 5


Yes

loginName

• Description



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


AX 4 and 5

For example,, 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

For example,, 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.

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


AX 4 and 5


Chapter 7EmailXtender 4.7

EmailXtender (EX) 4.7 backends support common backend configuration file properties described inthis guide.

Note: Do not edit the configuration file manually; instead, use the Admin Center. For moreinformation on Admin Center, see the ECI Services Administration Guide.

For the latest versions, updates, additions, and information on ECI Services and ECI Servicesadapters, visit the EMC Documentum website.

Principles of the EmailXtender adapterThe ECI Services server is not in direct relation with the EX server. To query an archive,the ECI Services server uses its own set of ASP scripts. The server runs the scripts toobtain the query description and to consult its folders. This script then retrieves the dataextracted for the ECI Services server, which wraps the results and displays them tothe user.

The ECIS_Adapter_EmailXtender.zip leThe ECIS_Adapter_EmailXtender.zip file includes the following:• EX.jar in <ECIS>/www/wrappers/core/• Backends sample files in <ECIS>/www/wrappers/core/EXBackends• Source-emclegato.gif in <ECIS>/tomcat/webapps/ao/data/sources• ECIS_EX47search.asp in <ECIS>/install/adapters/EX• ECIS_EX47download.asp in <ECIS>/install/adapters/EX• Following EX Runtime DLLs in <ECIS>/install/adapters/EX:

— ExMsgUnpackGW.dll


EmailXtender 4.7

— ExExchangeMsgUnpack.dll

— ExNotesMsgUnpack.dll

— ExSMTPMsgUnpack.dll

— implode.dll

— OTGNotesAPI.dll

— SearchSDKLib.dll

Note: You should unzip the ECIS_Adapter_EmailXtender.zip file in your <ECIS>installation folder.

Setting the EmailXtender runtime DLLsTo set the EX runtime DLLs, complete the following steps:

1. Copy the DLLs anywhere in the <ECIS>/install/adapter/EX folder.

2. Register each DLL by performing the following steps:

3. Open a command window.

4. Type regsvr32 runtime.dll for each of the DLLs.

Note: This step is not required for implode.dll.

EmailXtender server settingsThe EX adapter requires the MS Internet Information Services (IIS) server. Do notinstall the ASP on an EX server. We recommend you to install the IIS server on theECI Services server.

To set up the IIS server, perform the following steps:

1. Create an IIS virtual folder (alias: ECIS_EX).

2. Create a folder (for example, c:\Inetpub\ECIS_EX) with the default permissions(Read and Run Scripts).

3. Copy the .asp files (ECIS_EX47search.asp and ECIS_EX47download.asp) to thenewly created folder.

4. Create a temp folder in the ECIS_EX virtual directory. This folder is used to retrievea message from the EX archive when a user clicks on a message in the ECI interface.


EmailXtender 4.7

The default value is temp. If the value is different, change the backend’s values (seeEmailXtender adapter settings, page 61).

5. To ensure that messages are retrieved from the EX Archive, you need to configurethe MIME types. This configuration will enable IIS (EX web server) to deliver thespecified file types. If you do not perform this step, you will not be able to retrieveand read the mail message, because IIS delivers only known file types.

To configure the MIME types, perform the following steps:

6. In the temp folder properties dialog box, click the HTTP Headers tab.

Figure 7-1. The temp folder properties — HTTP Headers tab

7. ClickMIME Types.


EmailXtender 4.7

Figure 7-2. Mime Types dialog box

8. Click New.

Figure 7-3. New MIME Type dialog box

9. Fill out appropriate values in the fields.

10. Select Active Server Pages, and click Allow (see the following figure). You need toperform this step because Active Server Pages are not allowed by default.


EmailXtender 4.7

Figure 7-4. IIS server setup — Active Server Pages option

EmailXtender adapter settingsTo create a backend, start the AdminCenter (ecis/bin/aoAdmin.bat), and create a newintranet information source (EX). Follow the specified steps, and fill out the appropriatevalues.


EmailXtender 4.7

action

Table 7-1. action

Descrip-tion

Relative URL address for the search interface of the target data source(in this example, the ECIS_EX47search.asp page, in its aliased directory)For example:

action=ECIS_EX/ECIS_EX47search.asp

Value No default value

Manda-tory

Yes

bundle

Table 7-2. bundle

Descrip-tion

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

Value core/EX.jar

Manda-tory

Yes

VirtualDownloadPath

Table 7-3. VirtualDownloadPath

Descrip-tion

In order to consult archived messages and to allow the final user to readmessages, the EX API downloads the messages (.msg files) on the disk (inthe virtual directory defined in IIS). For example:

VirtualDownloadPath=/ECIS_EX/temp/

DefaultValue

No default value

Manda-tory

Yes


EmailXtender 4.7

PhysicalDownloadPath

Table 7-4. PhysicalDownloadPath

Descrip-tion

In order to consult archived messages and to allow the final user to readmessages, the EX API downloads the messages (.msg files) on the disk(in the physical directory that corresponds to the virtual path definedin IIS). For example:

PhysicalDownloadPath=D:\\ECIS_EX\\temp

DefaultValue

No default value

Manda-tory

Yes

download_url

Table 7-5. download_url

Descrip-tion

Script invoked by ECIS to visualize messages (.msg files). For example:

download_url=/ECIS_EX/ECIS_EX47download.asp

DefaultValue

No default value

Manda-tory

Yes

exserver

Table 7-6. exserver

Descrip-tion

EX servers to be searched. For example:

exservers=ED-XTENDER

DefaultValue

No default value

Manda-tory

Yes


EmailXtender 4.7

home

Table 7-7. home

Descrip-tion

URL of the information repository of the EmailXtender search interface.

DefaultValue

The default value is computed using the properties host, port, andprotocol of the backend. For example:

<protocol>://<host>:<port>

Manda-tory

No

host

Table 7-8. host

Descrip-tion

Host name of the EmailXtender (IIS server).

DefaultValue

No default value

Manda-tory

Yes

image

Table 7-9. image

Descrip-tion

Special logo used to represent results from this backend. For example,if the value of this property is “XX”, the logo should be stored inwww/tomcat/webapps/ao/data/sources/source-XX.gif.

DefaultValue

www/tomcat/webapps/ao/data/sources/source-<backend_name>.gif

Manda-tory

No, but the end-user cannot see the logo of the source in the domainpanel.


EmailXtender 4.7

protocol

Table 7-10. protocol

Descrip-tion

Protocol to be used when connecting to the source: http or https. Todisable the remote source authentication with https, use the valuehttps-no-auth. For example:

protocol=httpsor

protocol=https-no-auth

DefaultValue

http

Manda-tory

No

query

Table 7-11. query

Descrip-tion

List of primary attributes available for querying this source.

DefaultValue

Inherited from the adapter bundle.

query = full-text,link,URL,title,date

Manda-tory

No


EmailXtender 4.7

result

Table 7-12. result

Descrip-tion

List of known attributes returned by this source.

DefaultValue

Inherited from the adapter bundle

result = title,abstract,date,publisher,keywords,collection,URL,rank,score,size

Manda-tory

No

stopLimit

Table 7-13. stopLimit

Descrip-tion

Maximum number of results returned by this adapter.

DefaultValue

250

Manda-tory

No

ECI attributes for EmailXtenderECI provides the following EX queryable attributes: attachment, body, date, full-text(title OR body OR attachment), author, recipient, and title. These attributes are usedwith the ECI operators.

Operators

ECI provides the following operators:

• AND, OR, NOT: You can use it with attachment, body, full-text, or title.• CONTAINS: wildcard (*): You can use it with attachment, body, full-text, title.


EmailXtender 4.7

• WITHIN (distance): The retrieved documents must contain both terms, andthe second term must follow the appearance of the first. The second term canbe anywhere in the document, provided it is after the first. You can use it withattachment, body, full-text, title. If no distance is specified, 10 is the default.

• NEAR (distance): Both search terms must appear within the same paragraph. Theorder of appearance within the paragraph is not relevant. Placing a number betweenthe lines indicates the number of words separating the phrase. You can use it withattachment, body, full-text, title. If no distance is specified, 10 is the default.

• AFTER, BEFORE, EQUALS: You can use it with date. In EX, the AFTER date filterreturns hits received AFTER "dd/mm/yyyy 00:00:00". This will result in hits beingreturned on the specified day. Similarly, BEFORE date filter returns hits receivedBEFORE "dd/mm/yyyy 23:59:59". This also will result in hits being returned on thespecified day. ECI filters results that EQUALS dd/mm/yyyy.

Examples

The following table lists various examples for the ECI attributes.

Table 7-14. Example

Attribute Value Operator EX

Author mary miller CONTAINS/EQUALS

From:mary ANDmiller

Recipient “mary miller” CONTAINS/EQUALS

Toex:mary miller

Title Project 2 CONTAINS Subject: Project*AND 2*

Body “Project 2“ CONTAINS Subject: “Project 2”

date 2005-04-17 AFTER Date > 2005-04-1700:00:00


EmailXtender 4.7


Chapter 8JDBC/ODBC Adapter

Java supports a protocol named JDBC (Java Database Connectivity) to communicate andto query a relational databases system (RDBMS). Using JDBC, it is possible to connect ECIServices 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 awidely accepted standard to communicate with RDBMS. Most RDBMS provide an ODBC driver.

When an RDBMS provides both 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 following figure presents the communication between the participants of a requeston a 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.

Figure 8-1. An ECI Services query on JDBC


JDBC/ODBC Adapter

This figure presents the communication between the participants of a request on arelational database contacted with an ODBC driver through the Java built-in JDBC/ODBCbridge. 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 8-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 talking toan RDMS: use the ODBC driver (through JDBC/ODBC Bridge), or use a specific JDBCdriver 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 for the computer hosting ECI Services

1. If you decide to use the ODBC driver, you need to declare your ODBC source onyour system. (This is not explained here.) If you are using Windows NT, you canfollow the steps described below which illustrates this process with a Microsoft


JDBC/ODBC Adapter

Excel database. Otherwise, refer to the ODBC management section of your operatingsystem online help.

2. Launch theWindows NT control panel, choose theODBC data sources configurationpanel, and then choose the System DSN (Data Source Name).

3. Add a new source by clicking the Add button and selecting the driver correspondingto your database, for example Microsoft Access Driver.

4. Configure your ODBC driver with the information specific to your database.

Using a Direct JDBC driver

To correctly follow the procedure presented in this section, you need some knowledgeon Java.Get the JDBC driver for your source.

For many information sources, you can download it for free from the internet, or you canask your database provider for a JDBC driver for your system. It is a Java library that youcan 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.

1. Choose a host repository for your backend. This directory has to be over <ECISrepository>/www/wrappers.

2. Choose to use one that already exists or to create your own. For this example, thedirectory is: <ECIS repository>/www/wrappers/ODBC.

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

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

bundle

• Description


JDBC/ODBC Adapter

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

• 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

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


JDBC/ODBC Adapter

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.

For example, com.imaginary.sql.msql.MsqlDriver

For example, 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>

For example, jdbcUrl=jdbc:odbc:db1 (the jdbc URL of the Lotus Notes server)• Value

For example,, 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

selectClause

• Description

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


JDBC/ODBC Adapter

• Value

For example,, selectClause= publication_date,title,publisher,author,borrowing_status,isbn_issn

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

For example,, 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

For example,, 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

For example,, endClause=)

useToDate

• Description


JDBC/ODBC Adapter

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

For example,, 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

For example,, 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

For example,, likeMode= CLIKE

result.enclosingChar

• Description

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

nothing


JDBC/ODBC Adapter

• Value

For example,, result.enclosingChar= ’

image

• Description


• Default value


Yes

dateOutputFormat

• Description

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

• Value

For example, 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


JDBC/ODBC Adapter

# (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

For example, mapin.library1.title=title

means that "library1.title" which is received from the remote source will be addedin 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

For example, 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.

useFTI

Set to true if the database has a working Full-Text Index. If useFTI is set to true, full-textis mapped according to the value of the property mapout.full-text. You can also add’trusted=body’.

If useFTI is set to false, full-text is mapped to a set of columns according to the propertymap.full-text.


JDBC/ODBC Adapter

Default value: true

map.full-text

Defines the following list to map full-text (that is, a search on any attributes) to severalattributes when full-text is not supported by the database.

When useFTI is set to false, no index is available. Therefore, a constraint defined onfull-text is translated in the following attributes connected by ’OR’:

For example, if map.full-text = object_name, title, subject, ANY keywords, then full-text,CONTAINS, java in ECI Services means one of the following:

• object_name,CONTAINS,JAVA• title,CONTAINS,JAVA• subject,CONTAINS,JAVA• ANY keywords,CONTAINS,JAVASyntax: map.full-text=[Database attributes],[Database attributes],. . .


Chapter 9Sherlock

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, and they are developed eitherby web 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


Sherlock

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

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 isthe 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, all 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 correct directory, integrate the Sherlockplug-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 optionis not present, then the domain is Sherlock. For example, aOSherlockManager


Sherlock

YahooSherlock.src −dom General If you create a new domain in the ECI Servicesdomains root, then you will have to add its description in the configurationfiles: <ECIS directory>/www/docs/conf/ domainDescription_XX.properties(aOSherlockManager warns 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 ECIServices user interface (see the image property for all backends). If this option is notpresent, then the image property is sherlock. For example, aOSherlockManagerYahooSherlock.src −dom General −im yahoo

• 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’

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

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 79

• Description


• Default value


Yes

stopLimit

• Description

Maximum number of results returned by this adapter• Default value

50


Chapter 10Connecting 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. Therefore, it must propose web pagesfor which the URL starts with “https://” instead of the standard “http://”. In this case, use thefollowing steps to configure the adapter.

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

Conguring the adapter with HTTPSFor the entire development 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:


Connecting to a Source Using HTTPS

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

Wrapping the remote sourceAfter 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 are using a proxy the message could be the one ofthis later.

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 on the otherhand, there is no need to know (for example, trust) the remote source certificate. Use thisspecial value with special care.

Checking 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 install



dir>/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:

Saving the remote source certicate

To save the remote source certificate, perform the following steps:

1. Open Microsoft Internet Explorer and enter the url of the remote source. The urlmust starts with “https” (for example, https://www.safeweb.com) A security alertmessage box may appear 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.

2. Right click on the page, and select Properties, and then select Certificates.

Note: The Certification Path information screen appears. Close the window and godirectly to step 3. Otherwise, a message is displayed warning you that the certificateof the remote source is not trusted. You can click View certificate to view it.

3. Click Install Certificate.

An installation wizard is displayed, choose the appropriate option to let itautomatically select the certificate store and finish.

4. Being in Internet Explorer, select Tools → Internet Options.

5. Select the Content tab, and then select Certificate.

6. Select the appropriate tab corresponding to the store noted in the previous step(Other People, in the example).

7. Select the certificate in the list by looking for its name.

8. Click the Export button to save the certificate in a separate file.

A certificate export wizard is displayed.

9. For the format of the certificate file, choose DER encoded binary X.509 or Base-64encoded X.509.

10. Browse the directories, and create a new certificate file. For this example, call itsafeweb.cer.

11. Save the certificate in <aO install dir>/www/docs/conf repository.

12. Complete the steps of the wizard.



The file is created.

13. Close the windows.

The remote source certificate has been saved.

14. Add this certificate to the ECI Services trusted certificates store.

Adding the certicate to ECI Services keystore le

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.

To add the certificate to the ECI Services keystore file, perform the following steps:

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

2. Open a DOS console, go to this directory, and type the following 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 chosen for the certificate. Any name can be chosen. Type aname that can help you identify the associated certificate.

<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 (for example, trustedCerts.cer, which is the default trusted certificateskeystore file for ECI Services). It can be replaced by any other certificate keystore file.

Consider the following example:<aO install dir>/_jvm/bin/keytool −import −alias safeweb −filesafeweb.cer −keystore trustedCerts.cer

In this example, the password of the trustedCerts store is changeit.

The keytool utility prompts to confirm the addition of the new certificate.

3. Type Yes.

The new certificate to trust is added.

4. Verify that the adapter can connect to the 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, 16, 47, 53

AX 4 and 5, 53eRoom 7 adapter, 47

actionX, 16adapter

bundles, 12adapter backend

configuring for JDBC/ODBCadapter, 71

adapters, 12add the certificate to ECI Services keystore

fileHTTPS, 86

administering the plug-inSherlock, 81

applicationFields, 54AX 4 and 5, 54

applicationName, 53AX 4 and 5, 53

attributes, 43Documentum adapter, 43

AX 4, 51AX 4 and 5

action, 53applicationFields, 54applicationName, 53bundle, 52host, 53login_action, 53loginName, 54mapin.X, 54mapout.X, 55principles, 51setting the adapter, 51

AX 5, 51

Bbackend properties

Sherlock, 82

backends, 12baseName, 36

Documentum adapter, 36bundle, 13, 35, 47, 52, 71

AX 4 and 5, 52Documentum adapter, 35eRoom 7 adapter, 47JDBC/ODBC adapter, 71

bundlesadapter, 12

Ccheck the remote source certificate

HTTPS, 84client.* properties, 27client.dfc.types, 27

Documentum adapter, 27client.overview, 26client.resultIcon, 27common backend configuration

action, 16actionX, 16bundle, 13client.* properties, 27client.overview, 26client.resultIcon, 27dateFormat, 23duplicate, 21duplicateKey, 21encoding, 24expirationTime, 20file properties, 13filter, 20home, 15host, 14image, 25location, 26loginName, 18loginPassword, 18maxSubsumedQueries, 25


Index

method, 17methodX, 17modificationKey, 22port, 14protocol, 15protocolX, 15proxySet, 18query, 19queryLanguage, 22result, 19stopLimit, 20strategy, 23supportsLogin, 17supportsSubsumption, 25trusted, 24

configure the adapterHTTPS, 83

configuringadapter backend for JDBC/ODBC

adapter, 71connecting to a source using HTTPS, 83constraint, 38

Documentum adapter, 38creating plug-ins

Sherlock, 81CustomFields, 49

eRoom 7 adapter, 49

Ddatabase drivers

installation and configuration, 70dateFormat, 23dateOutputFormat, 76

JDBC/ODBC adapter, 76direct JDBC driver

using, 71docType, 38

Documentum adapter, 38Documentum adapter

attributes, 43baseName, 36bundle, 35client.dfc.types, 27constraint, 38docType, 38filter, 38host, 36image, 36location, 39

loginName, 37loginPassword, 37map.full-text, 43mapin.<Documentum attributes>, 41mapmerge, 42mapmerge.<ECIS attributes>, 42mapout.<ECIS attributes>, 41port, 37preferredRendition, 40proxySet, 44query, 40result, 40secondaryRendition, 41setting, 35stopLimit, 38supportsLogin, 37trusted, 39useFTI, 39viewUrl, 39

duplicate, 21duplicateKey, 21

EECI Services script for eRoom

installing, 45EmailXtender, 57encoding, 24endClause, 74

JDBC/ODBC adapter, 74eRoom 7, 45eRoom 7 adapter

action, 47bundle, 47CustomFields, 49eRoomName, 48facilityName, 48host, 47loginName, 48

eRoom adapterprinciples, 45

eRoom AdapterSetting, 46

eRoomName, 48eRoom 7 adapter, 48

expirationTime, 20

FfacilityName, 48


Index

eRoom 7 adapter, 48file properties

action, 16actionX, 16bundle, 13client.* properties, 27client.overview, 26client.resultIcon, 27common backend configuration, 13dateFormat, 23duplicate, 21duplicateKey, 21encoding, 24expirationTime, 20filter, 20home, 15host, 14image, 25location, 26loginName, 18loginPassword, 18maxSubsumedQueries, 25method, 17methodX, 17modificationKey, 22port, 14protocol, 15protocolX, 15proxySet, 18query, 19queryLanguage, 22result, 19stopLimit, 20strategy, 23supportsLogin, 17supportsSubsumption, 25trusted, 24

filter, 20, 38Documentum adapter, 38

fromClause, 74JDBC/ODBC adapter, 74

Hhome, 15host, 14, 36, 47, 53

AX 4 and 5, 53Documentum adapter, 36eRoom 7 adapter, 47

HTTPS

add the certificate to ECI Serviceskeystore file, 86

check the remote source certificate, 84configure the adapter, 83connecting to a source, 83save the remote source certificate, 85wrap the remote source, 84

Iimage, 25, 36, 76

Documentum adapter, 36JDBC/ODBC adapter, 76

Image, 82Sherlock, 82

installation and configurationdatabase drivers, 70

installingECI Services script for eRoom, 45

installing plug-inSherlock, 79

JJDBC, 69JDBC/ODBC adapter

bundle, 71dateOutputFormat, 76endClause, 74fromClause, 74image, 76jdbcDriver, 73jdbcUrl, 73keyAttribute, 75likeMode, 75mapin.X, 77mapout.X, 77principles, 69query, 72query.enclosingDate, 76result, 72result.enclosingChar, 75selectClause, 73trusted, 72useToDate, 74whereClause, 74

JDBC/ODBC bridgeusing, 70

jdbcDriver, 73JDBC/ODBC adapter, 73


Index

jdbcUrl, 73JDBC/ODBC adapter, 73

KkeyAttribute, 75

JDBC/ODBC adapter, 75

LlikeMode, 75

JDBC/ODBC adapter, 75location, 26, 39

Documentum adapter, 39login_action, 53

AX 4 and 5, 53loginName, 18, 37, 48, 54

AX 4 and 5, 54Documentum adapter, 37eRoom 7 adapter, 48

loginPassword, 18, 37Documentum adapter, 37

Mmap.full-text, 43

Documentum adapter, 43mapin.<Documentum attributes>, 41

Documentum adapter, 41mapin.X, 54, 77

AX 4 and 5, 54JDBC/ODBC adapter, 77

mapmerge, 42Documentum adapter, 42

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

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

mapout.X, 55, 77AX 4 and 5, 55JDBC/ODBC adapter, 77

maxSubsumedQueries, 25method, 17methodX, 17modificationKey, 22

OODBC, 69

Pport, 14, 37

Documentum adapter, 37preferredRendition, 40

Documentum adapter, 40principles

AX 4 and 5, 51JDBC/ODBC adapter, 69

protocol, 15protocolX, 15proxySet, 18, 44

Documentum adapter, 44

Qquery, 19, 40, 72


query.enclosingDate, 76JDBC/ODBC adapter, 76

queryLanguage, 22

Rresult, 19, 40, 72


result.enclosingChar, 75JDBC/ODBC adapter, 75

Ssave the remote source certificate

HTTPS, 85secondaryRendition, 41

Documentum adapter, 41selectClause, 73

JDBC/ODBC adapter, 73setting

Documentum adapter, 35Setting

eRoom Adapter, 46setting the adapter

AX 4 and 5, 51Sherlock, 79

administering the plug-in, 81backend properties, 82creating plug-ins, 81Image, 82installing plug-in, 79


Index

stopLimit, 82stopLimit, 20, 38, 82

Documentum adapter, 38Sherlock, 82

strategy, 23supportsLogin, 17, 37

Documentum adapter, 37supportsSubsumption, 25

Ttrusted, 24, 39, 72


UuseFTI, 39

Documentum adapter, 39useToDate, 74

JDBC/ODBC adapter, 74using

direct JDBC driver, 71JDBC/ODBC bridge, 70

VviewUrl, 39

Documentum adapter, 39

WwhereClause, 74

JDBC/ODBC adapter, 74wrap the remote source

HTTPS, 84
