EnterpriseContentIntegration ServicesMicrosoftOf ... · TableofContents Preface..... 5 Chapter1...

Enterprise Content IntegrationServices Microsoft Ofce SharePoint

Portal Server 2003 AdapterInstallation Guide

Version 5.3 SP1October 2005

Contains software developed by the Apache Software Foundation. Distribution subject to the Apache Software License. Contains the HTTPClient Library, © 1996-1998, Ronald Tschalaer. Distribution subject to the GNU Library General Public License. Contains the Cryptix library,Copyright © 1995-2001 The Cryptix Foundation Limited. All rights reserved. Distribution subject to the Cryptix General License. Contains theMM.MySQL driver. Copyright (c) 1998-1999 Mark Matthews. Distribution subject to the GNU Library General Public License. Contains thePager-Taglib, Copyright © 2002 James Klicman <[email protected]>. Distribution subject to the GNU Library General Public License. PortionsCopyright © 2000 World Wide Web Consortium, (Massachusetts Institute of Technology, Institut National de Recherche en Informatique et enAutomatique, Keio University). All Rights Reserved.Microsoft® Office SharePoint®Microsoft, Windows, Windows NT, Microsoft Office SharePoint Portal Server 2003, Integrated Windows Authentication, Internet InformationServices (IIS), Microsoft Internet Explorer, and SharePoint are either registered trademarks or trademarks of Microsoft Corporation in the UnitedStates and/or other countries.The names of actual companies and products mentioned herein may be the trademarks of their respective owners.Copyright © 1994-2005 EMC Corporation. All rights reserved.

Table of Contents

Preface .......................................................................................................................... 5

Chapter 1 Overview ............................................................................................... 7

Chapter 2 Installing the Adapter ............................................................................ 9Installation requirements ............................................................................ 9Source software requirement ................................................................... 9Compatibility ......................................................................................... 9

Installing the adapter bundle....................................................................... 9

Chapter 3 Adapter Properties ................................................................................ 11Configurable properties .............................................................................. 11Bundle ................................................................................................... 11Host ...................................................................................................... 12Port ....................................................................................................... 12Protocol ................................................................................................. 12Supports Login....................................................................................... 13Stop Limit .............................................................................................. 13Optimized Stop Limit ............................................................................. 14Scope ..................................................................................................... 14Date Format ........................................................................................... 14Trusted .................................................................................................. 15Query .................................................................................................... 15Result .................................................................................................... 16Image .................................................................................................... 16

Configuration limitation ............................................................................. 16Problem ................................................................................................. 16Cause .................................................................................................... 17Action.................................................................................................... 17

Chapter 4 Authentication ...................................................................................... 19Search and security..................................................................................... 19Document access and security ..................................................................... 19

Chapter 5 Query Translation .................................................................................. 21Constraints operators.................................................................................. 21And ....................................................................................................... 21Or.......................................................................................................... 22And Not ................................................................................................ 22Wildcard................................................................................................ 22

Attributes .................................................................................................. 23Operators................................................................................................... 23

Enterprise Content Integration Services Microsoft Ofce SharePoint Portal Server 2003 Adapter Installation Guide 3

Table of Contents

List of Tables

Table 3–1. bundle ........................................................................................................... 11Table 3–2. host ............................................................................................................... 12Table 3–3. port ............................................................................................................... 12Table 3–4. protocol ......................................................................................................... 12Table 3–5. supportsLogin ................................................................................................ 13Table 3–6. stopLimit ....................................................................................................... 13Table 3–7. optimizedStopLimit........................................................................................ 14Table 3–8. scope ............................................................................................................. 14Table 3–9. dateFormat .................................................................................................... 14Table 3–10. trusted ........................................................................................................... 15Table 3–11. query ............................................................................................................. 15Table 3–12. result ............................................................................................................. 16Table 3–13. image ............................................................................................................ 16Table 5–1. And ............................................................................................................... 21Table 5–2. Or.................................................................................................................. 22Table 5–3. And Not ........................................................................................................ 22Table 5–4. Wildcard........................................................................................................ 22Table 5–5. Attributes ...................................................................................................... 23Table 5–6. Operators....................................................................................................... 23

4 Enterprise Content Integration Services Microsoft Ofce SharePoint Portal Server 2003 Adapter Installation Guide

Preface

Enterprise Content Integration (ECI) Services provides the following content integration features:• Multi-Docbase searches• Search capabilities within external repositoriesECI Services, along with a number of other Documentum products, provides a number of features.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, thereby 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. Formore information on Admin Center, refer to Enterprise Content Integration ServicesAdministration Guide. This document contains references to configuration files and thepossibility to edit them. Manual configuration should only be performed by experiencedadministrators for troubleshooting purposes.

Revision historyThe following changes have been made to this document.

Revision history

Revision date Description

October 2005 Initial release


Chapter 1Overview

The Microsoft Office SharePoint Portal Server 2003 adapter makes the Microsoft Office SharePointPortal Server 2003 searchable from EMC Documentum Enterprise Content Integration (ECI) Services.

The adapter interacts with Microsoft SharePoint Portal Server Search (SharePointPSSearch) throughthe Microsoft Office SharePoint Portal Server 2003 Query Service web service.


Overview


Chapter 2Installing the Adapter

This chapter provides information on installation requirements and installation instructions.

Installation requirements

Source software requirement

The source software has to be Microsoft Office SharePoint Portal Server 2003. Theadapter searches the Microsoft Office SharePoint Portal Server 2003 through its QueryService web service that can be reached at http://[host]/_vti_bin/search.asmx.

Compatibility

The Microsoft Office SharePoint Portal Server 2003 adapter and the Lexis Nexis adapterare not compatible. Installing the Microsoft Office SharePoint Portal Server 2003 adapteron an ECI Services server is not compatible with the Lexis Nexis adapter.

Installing the adapter bundleTo install the adapter bundle, make sure to extract the adapter archive at the root level ofyour ECI Services installation. For example, if your ECI Services server is installed underC:\Program Files\Documentum\eci, extract the archive to this folder.


Installing the Adapter

If you have installed ECI Services 5.3 SP1, you will be prompted to replace JAVA classes.Accept the replacement if the compatibility section of this guide is not relevant to yourrequirement.


Chapter 3Adapter Properties

This chapter lists the configurable properties of the Microsoft Office SharePoint Portal Server 2003adapter. In addition, it provides information on the configuration limitation of the adapter.

This chapter includes the following sections:

• Configurable properties, page 11• Configuration limitation, page 16

Congurable propertiesThe Microsoft Office SharePoint Portal Server 2003 adapter includes the followingproperties:

Bundle

Table 3-1. bundle

Item Description

ID bundle

Description Name and path of the adapter bundleused for this backend. The path isspecified from the adapter repository(docs/adapters).

Default value core/Sharepoint.jar

Mandatory yes


Adapter Properties

Host

Table 3-2. host

Item Description

ID host

Description Microsoft Office SharePoint Portal Server2003 HTTP server name. It can be eitheran IP address or a valid DNS name,for example, www.sharepoint.com or152.62.52.23.

Default value

Mandatory yes

Port

Table 3-3. port

Item Description

ID port

Description Server port number

Default value (No value means port 80)

Mandatory no

Protocol

Table 3-4. protocol

Item Description

ID protocol

Description Hypertext Transfer Protocol (http). Sethttps if the connections are secured (SSLor TSL).


Adapter Properties

Item Description

Default value http

Mandatory no

Supports Login

Table 3-5. supportsLogin

Item Description

ID supportsLogin

Description When set to true, the SharePoint PortalServer 2003 requires a login and apassword. If a user does not enter a loginand a password, the adapter uses thecredentials that you have set in this form,if any.

Default value true

Mandatory no

Stop Limit

Table 3-6. stopLimit

Item Description

ID stopLimit

Description ECI limits its response to this number. Bydefault, the limit is set to 50.

Default value 50

Mandatory no


Adapter Properties

Optimized Stop Limit

Table 3-7. optimizedStopLimit

Item Description

ID optimizedStopLimit

Description The value of the SharePoint hint. It shouldbe higher than the ECI stopLimit property.

Default value 70

Mandatory no

Scope

Table 3-8. scope

Item Description

ID scope

Description The scope of the search is the locationfrom which the query returns the results.

Default value (TABLE Portal_Content..Scope() UNIONALL TABLE Non_Portal_Content..Scope())

Mandatory no

Date Format

Table 3-9. dateFormat

Item Description

ID dateFormat

Description Microsoft Office SharePoint PortalServer 2003 date format, for example,2004-12-12T16:52:10Z.


Adapter Properties

Item Description

Default value yyyy-MM-dd’T’hh:mm:ss’Z’

Mandatory no

Trusted

Table 3-10. trusted

Item Description

ID trusted

Description No filtering will be done by ECI Serviceson this list of attributes. It is often usedwhen the source sends only partial results.

Default value author,full-text,URL,abstract

Mandatory no

Query

Table 3-11. query

Item Description

ID query

Description The list of primary ECI Services attributesavailable for querying this source.

Default value title,full-text,date,author,ab-stract,size,URL

Mandatory no


Adapter Properties

Result

Table 3-12. result

Item Description

ID result

Description The list of known ECI Services attributesreturned by this source.

Default value title,author,date,URL,abstract,size

Mandatory no

Image

Table 3-13. image

Item Description

ID image

Description Special logo used to represent results fromthis backend. If the value of this propertyis “XX”, the logo should be stored inthe following location: www/tomcat/webapps/ao/data/sources/source-XX.gif

Default value sharepoint

Mandatory no

Conguration limitationThis section provides information on the configuration limitation of the Microsoft OfficeSharePoint Portal Server 2003 adapter.

Problem

While configuring the Microsoft Office SharePoint Portal Server 2003 adapter, an out ofmemory error may appear.


Adapter Properties

Cause

The out of memory error occurs due to a memory leak of the adapter in the Admin Center.

Action

Do not click the test button several times (more than 10 times).


Adapter Properties


Chapter 4Authentication

This chapter provides information on the supported authentication mode. It includes the followingsections:

• Search and security, page 19• Document access and security, page 19

Search and securityThe default Microsoft Office SharePoint Portal Server 2003 authentication mode isNTLM. The Microsoft Office SharePoint Portal Server 2003 adapter supports IntegratedWindows Authentication (formerly called NTLM or Windows NT Challenge/Responseauthentication). It uses this secure form of authentication to search on the MicrosoftOffice SharePoint Portal Server 2003.

Document access and securityThe Microsoft Office SharePoint Portal Server 2003 adapter does not manage thedocument access security. The adapter provides a link to the Microsoft Office SharePointPortal Server 2003 document. The web client and the web server work together to handlethe security. The Internet Information Services (IIS) web server linked to the MicrosoftOffice SharePoint Portal Server 2003 requests the user to log on. If the user browsersupports Integrated Windows Authentication, like Microsoft Internet Explorer does, itautomatically sends the user’s credentials. In this case, the user will not be promptedfor a user name and a password. The current Windows® user information on theclient computer is used for the Integrated Windows Authentication. However, if theauthentication exchange initially fails to identify the user, the browser will prompt theuser for a Windows® user account user name and password.


Authentication

The Integrated Windows Authentication is appropriate for an intranet environment,where both user and Web server computers are in the same domain, and whereadministrators can ensure that every user has Microsoft Internet Explorer.


Chapter 5Query Translation

The ECI Services translator translates a query into a Microsoft Office SharePoint Portal Server 2003query. This chapter describes how the queries are translated.

SharePointPSSearch provides content crawling and search features that support full-text searching.The query language used by SharePointPSSearch extends the standard SQL-92 and SQL-99 databasequery syntax to enhance its usefulness with text-based searches. Refer to the Microsoft documentationfor more information.

Constraints operatorsThe supported constraint operators are as follows:

And

Table 5-1. And

Item Description

Value AND

Example … WHERE (( ( (Contains("urn:schemas.microsoft.com:fulltextqueryinfo:dis-playtitle",’"Guide*"’)) AND (Con-tains("urn:schemas.microsoft.com:fulltex-tqueryinfo:displaytitle",’"Installation*"’)))) )


Query Translation

Or

Table 5-2. Or

Item Description

Value OR

Example … WHERE (( ( (Contains("urn:schemas.microsoft.com:fulltextqueryinfo:dis-playtitle",’"Manual*"’)) OR (Con-tains("urn:schemas.microsoft.com:fulltex-tqueryinfo:displaytitle",’"Agent*"’)) )) )

And Not

Table 5-3. And Not

Item Description

Value AND NOT

Example … WHERE (( ( (Contains("urn:schemas.microsoft.com:fulltextqueryinfo:dis-playtitle",’"Manual*"’)) AND NOT (Con-tains("urn:schemas.microsoft.com:fulltex-tqueryinfo:displaytitle",’"Agent*"’)) )) )

Wildcard

Table 5-4. Wildcard

Item Description

Value *

Example …WHERE (( (Contains("urn:schemas.mi-crosoft.com:fulltextqueryinfo:displayti-tle",’"OFC*"’)) ) )

Note: The NEAR and WITHIN operators are not implemented. ECI Services filters theresults in order to emulate their behaviors when they are used by the users.


Query Translation

AttributesThe following attributes are searchable. Some attributes are trusted. That is, ECI Servicesdoes not perform any filtering on the source result.

Table 5-5. Attributes

Name Trusted Default values

Title No urn:schemas.mi-crosoft.com:fulltextquery-info:displaytitle

Full-text Yes ALL (When the full textcolumn is specified as"ALL", all indexed textproperties are searched.)

Date No DAV:getlastmodified

Author Yes urn:schemas-microsoft-com:office:office#Author

Abstract Yes urn:schemas.mi-crosoft.com:fulltextquery-info:description

Size No DAV:getcontentlength

URL Yes DAV:href

OperatorsThe supported operators are listed in the following table:

Table 5-6. Operators

Name Type Example

AFTER Date WHERE ("DAV:getlastmodified" > ’2005-09-02’)

BEFORE Date WHERE ("DAV:getlastmodified" < ’2005-09-02’)

CONTAINS String WHERE (( (Contains("urn:schemas.microsoft.com:fulltextqueryinfo:displaytitle",’"Guide*"’)) ) )

EQUAL Numerical WHERE ("DAV:getcontentlength" = 10000)


Query Translation

Name Type Example

EQUAL_GREATER

Numerical WHERE ("DAV:getcontentlength" >= 10000)

EQUAL_LOWER Numerical WHERE ("DAV:getcontentlength" <= 10000)

EQUALS_TO String WHERE (( "urn:schemas.microsoft.com:fulltextqueryinfo:displaytitle" =’guide_demarrage’) )

GREATER Numerical WHERE ("DAV:getcontentlength" > 10000)

LOWER Numerical WHERE ("DAV:getcontentlength" < 10000)


Index

Aadapter

installing, 9properties, 11

Andconstraints operator, 21

And Notconstraints operator, 22

attributes, 23authentication, 19

document access, 19search, 19security, 19

Bbundle

property, 11

Ccompatibility

requirements, 9configuration

limitation, 16constraints operators, 21

And, 21And Not, 22Or, 22Wildcard, 22

DdateFormat

property, 14document access

authentication, 19

Hhost

property, 12

Iimage

property, 16installation requirements, 9installing

adapter, 9SharePoint, 9

Llimitation

configuration, 16

Ooperators, 23optimizedStopLimit

property, 14Or

constraints operator, 22overview

SharePoint, 7

Pport

property, 12properties

adapter, 11bundle, 11dateFormat, 14host, 12image, 16optimizedStopLimit, 14port, 12protocol, 12query, 15result, 16scope, 14stopLimit, 13supportsLogin, 13


Index

trusted, 15protocol

property, 12

Qquery

property, 15query translation, 21

Rrequirements

compatibility, 9source software, 9

resultproperty, 16

Sscope

property, 14SharePoint

installing, 9overview, 7

source softwarerequirements, 9

stopLimitproperty, 13

supportsLoginproperty, 13

Ttrusted

property, 15

WWildcard

constraints operator, 22


Date post:	24-Mar-2020
Category:	Documents
Upload:	others
View:	5 times
Download:	0 times

EnterpriseContentIntegration ServicesMicrosoftOf ... · TableofContents Preface..... 5 Chapter1...

Documents