Professional Documents
Culture Documents
This document describes the overview, installation and configuration for Federated
Search for Phillips Petroleum Corporation of SharePoint Portal Server 2001.
Page 1/19
Table of Contents
1 OVERVIEW.........................................................................................................................................3
FEDERATED SEARCH...................................................................................................................................3
2 ARCHITECTURAL OVERVIEW......................................................................................................4
SEARCH WEB SERVICE...............................................................................................................................4
FEDERATED SEARCH WEB PARTS.................................................................................................................5
Simple Search Web Part....................................................................................................................5
Advanced Search Web Part...............................................................................................................6
Matching Documents Web Part........................................................................................................7
3 FEDERATED SEARCH INSTALLATION.......................................................................................8
PRE-REQUISITES.........................................................................................................................................8
INSTALLATION FILES...................................................................................................................................9
SERVER INSTALLATION..............................................................................................................................10
Creating and Configuring the SOAP Virtual Directory..................................................................10
Using RegisterComps.vbs...............................................................................................................11
Registering SPSWebService............................................................................................................12
Registering SPSSearchService........................................................................................................12
Registering PhillipsSPS..................................................................................................................12
Creating and Configuring COM+ Security Application................................................................13
Configuring the federatedSearch.WSDL File.................................................................................13
Configuring SearchConfig.xml.......................................................................................................14
Configuring searchserver.xml.........................................................................................................15
WORKSPACE INSTALLATION.......................................................................................................................16
Adding Resource folder files to workspace.....................................................................................16
Configuring the Workspace Resource folder to a Virtual Directory...............................................16
Importing and Configuring the Federated Search Web Parts .......................................................17
Simple Search Web Part..............................................................................................................17
Advanced Search and Matching Documents Web Parts.............................................................17
4 FEDERATED SEARCH MAINTENANCE.....................................................................................18
CONFIGURATION MAINTENANCE.................................................................................................................18
Managing SearchConfig.xml..........................................................................................................18
Managing searchserver.xml............................................................................................................18
SECURITY MAINTENANCE.........................................................................................................................18
Maintaining the Search Service Account for Searching the Enterprise.........................................18
Refreshing MS Exchange Information Store to Release SharePoint Portal Server Cached
Credentials.......................................................................................................................................19
Page 2/19
1 Overview
The following document contains the architectural overview and installation procedures,
configuration and maintenance tasks for the Federated Search feature for the SharePoint
Portal Server 2001. This document is intended for SharePoint Coordinators and/or
Knowledge Management technical personnel who are well familiar with administering
SharePoint Portal Server. To become more familiar with SharePoint Portal Server please go
to the online documentation found on http://microsoft.com/sharepoint/portalserver.asp .
Federated Search
The Federated Search feature uses the term federated due to the extensibility of its search
options. A federated search allows a user to span multiple search engines throughout the
intranet. Each search engine is represented by a SharePoint Portal server at a different
location destination.
Local Workspaces/Portals
Search Requests
Searching Other
Locations
Search Requests
from Other
Locations
Page 3/19
2 Architectural Overview
The Federated Search feature encompasses several technologies to allow users to access
the correct workspace information for each location and to search for content at specific
locations.
The document server contains all the workspaces where the users will be using the federated
Search. Each of the workspaces will contain the federated search web parts which will be
covered in the next sections. These web parts are the user entry points for the federated
search and interact with the web service to dynamically populate content on the client side for
locations, workspaces and document profiles. The web service is used as a proxy to other
document servers for retrieving workspace names and document profile information for each
of the workspaces. The location allows the web service to pull information from the
appropriate document server.
Other Locations
Document Server
User selects a
location/workspace Web service Web Service will go to other
locations to retrieve
Workspaces and Document
Location workspaces Profiles based on request.
XML Data
and/or document profiles
returned from Web
Service
Search Results by
Location
XML Data
Page 4/19
Federated Search Web Parts
The Federated Search feature is a custom solution that allows users from a workspace to
access multiple workspaces on the same server or other SharePoint Portal Servers. It
consists of three new custom web parts which include the Simple Search Web Part,
Advanced Search Web Part and the Matching Documents Web Part. These web parts interact
with the search web service for building a search call and making the search call.
The simple search web part allows a user to search for content in the workspace they are
currently working in. The web part is located on the home dashboard, categories dashboard
and the document library dashboard. It consists of a text entry field for search criteria, the
location label where the SharePoint Portal Server resides and the workspace label of the
current workspace name. Upon submission using the Go button, the results will appear in the
Search dashboard in the Matching Documents Web Part.
Page 5/19
Advanced Search Web Part
The Advanced Search web part allows a user to further search for content outside of the
workspace as well as the current workspace. The Advanced search allows for a more detailed
search which includes multiple locations. Each location consists of multiple workspaces and
each workspace consists of multiple document profiles pre-defined by SharePoint
Administrators.
Page 6/19
Matching Documents Web Part
The Matching Documents web part displays the results from the Simple Search and
Advanced Search web parts. It emulates the same look and feel as the out-of-box solution. If
a user selected multiple locations, each location will be displayed with the total number of
results find for that location. A user will then be able to select the location to further refine the
location search.
Page 7/19
3 Federated Search Installation
Installation of the federated Search consists of two installations, a server instance install
which is only done once per server and a workspace level instance which is done for every
workspace on the Document Server.
*Note: It is important to follow this installation in the order the document follows. This will
ensure a correct installation.
Pre-requisites
The document entitled Design Architecture and Deployment of SharePoint Portal Server 2001
using a three server configuration for Phillips Petroleum contains the configuration needed
prior to installing the Federated Search Functionality. Setting up the environment is a
requirement for the federated search functionality.
The install files for the items above can be found in the Federated Search/Installs folder.
Page 8/19
Installation Files
The installation files consist of the Federated Search directory which includes four folders.
These folders are the Installs folder, Soap folder, Resource folder and Web Parts folder. The
files for each folder are as follows:
Make sure to verify that the above files are available. These files are needed to continue
installation.
Page 9/19
Server Installation
The following procedure should only be done once on the document server instance for a
location. This installation procedure will serve for both a multi-server scenario and a single
server scenario. Any installation differences for the single and multi-server will be clarified
during the installation process.
• Under the Federated Search Install directory copy the entire Soap directory to
<DRIVE>:\inetpub\wwwroot folder. This will be the location where the virtual directory will
be located.
• Go to StartProgramsAdministrative ToolsInternet Services Manager.
Selecting the Internet Service Manager will open the IIS Administrative Console.
• Expand the Server Name and then the Default Web site.
• Right-Click on the Default Web Site and select NewVirtual Directory. The Virtual
Directory Wizard appears.
• Hit Next.
• Enter soap in the alias entry field.
• Hit Next.
• Browse to the <DRIVE>:\inetpub\wwwroot folder and select the soap folder that was
copied their. In the directory field, <DRIVE>:\inetpub\wwwroot\Soap should appear.
• Hit Next.
• In the Access Permissions section, make sure the Read, Run Scripts and Execute are
checked, if not select them.
• Hit Next.
• Hit Finish, you have successfully created the soap virtual directory.
• Under the Default Web site the soap virtual directory should appear. Right-Click on the
soap virtual directory and select properties.
• Under the Virtual Directory Tab change the Application Protection select field to
display Low (IIS Process)
• Under the Directory Security Tab, click Edit in the Anonymous access and
authentication control section. The Authentication Methods menu appears.
• Deselect Anonymous access.
• Select Integrated Windows Authentication if not already selected.
• Hit OK.
• Soap virtual directory creation and configuration is complete.
Page 10/19
Using RegisterComps.vbs
The RegisterComps.vbs file is an installation. It registers the SPSWebService.dll,
SPSSearchService.dll and PhillipsSPS.dll. It also creates and configure the COM+
Application. The RegisterComps.vbs file must be configured to the environment it will be used
in.
*Note: If you do not wish to use the RegisterComps.vbs, skip this section. If this script is used
the sections Registering SPSWebService, RegisteringSearchService, Registering PhillipsSPS
and Creating and Configuring COM+ Security Application may be skipped. The
RegisterComps.vbs script is equivalent to using these sections.
Page 11/19
Registering SPSWebService
• Go to StartRun.
• Enter cmd and Hit OK. A command prompt will appear.
• If the inetpub\wwwroot\Soap directory is not on the c:\, then type <Drive letter>: to change
to correct drive.
• Type cd \ (Takes you to drive root directory )
• Type cd inetpub\wwwroot\Soap (You are now in the soap directory)
• To register the SPSWebService.DLL type the following:
A window should appear that says DLL has been registered successfully.
Registering SPSSearchService
• Go to StartRun.
• Enter cmd and Hit OK. A command prompt will appear.
• If the inetpub\wwwroot\Soap directory is not on the c:\, then type <Drive letter>: to change
to correct drive.
• Type cd \ (Takes you to drive root directory )
• Type cd inetpub\wwwroot\Soap (You are now in the soap directory)
• To register the SPSWebService.DLL type the following:
A window should appear that says DLL has been registered successfully.
Registering PhillipsSPS
• Go to StartRun.
• Enter cmd and Hit OK. A command prompt will appear.
• If the inetpub\wwwroot\Soap directory is not on the c:\, then type <Drive letter>: to change
to correct drive.
• Type cd \ (Takes you to drive root directory )
• Type cd inetpub\wwwroot\Soap (You are now in the soap directory)
• To register the SPSWebService.DLL type the following:
A window should appear that says DLL has been registered successfully.
Page 12/19
Creating and Configuring COM+ Security Application
A COM+ Security Application will be needed for searching across from location to location.
COM+ propagates security credentials of an authorized search against other SharePoint
Portal Servers.
Page 13/19
Configuring SearchConfig.xml
The Location name specifies the desired name for a location. The Document and Search
Server must contain a valid server name.
*Note: For a single server the SearchServer is also the DocumentServer so you must specify
the server name twice.
• Change the Location name, DocumentServer and SearchServer values to the appropriate
servers.
• For each additional location, you must append a new Location Node. The following is an
example of such:
• Save the changes and exit the text editor. Before saving verify all the information is
correct and spelled correctly. The XML file is case sensitive so any XML node changes
such as Documentserver as compared to DocumentServer will cause the reading
program to error.
• SearchConfig.xml configuration is complete.
Page 14/19
Configuring searchserver.xml
*Note: For a single server the SearchServer is also the DocumentServer so you must specify
the server name twice.
*Important: The searchserver.xml should only contain one entry, the entry for the current
location. The Search Server entry must also match the Search Server entry in the
SearchCofig.xml. If the SearchConfig.xml contains the Search Server “BVLSPS01” then the
searchserver.xml should contain “BVLSPS01”.
Page 15/19
Workspace Installation
The following procedure should be repeated for every workspace needing installation. This
installation procedure will serve for both a multi-server scenario and a single server scenario.
Any installation differences for the single and multi-server will be clarified during the
installation process.
• Expand My Network Places and then Expand the workspace needing installation. The
workspace item follows the form <Workspace Name> on <Server Name>.
*Note: If the workspace name is not under My Network Places then you must add a shortcut
to the web folder.
To Add a shortcut
o Right Click on My Network Places and select Map Network Drive.
o Click on the link “Create a Shortcut to a Web Folder or ftp site”
o In the Location of the Network Place field, enter
http://<server_name>/<workspace_name>
o Hit Next.
o Hit Finish. The shortcut should now appear under My Network Places.
Page 16/19
• Workspace Resource folder configuration is complete.
Page 17/19
• In the embedded content section, inside the GetContent function look for the variable
s_SoapDirectory. Change the value to the physical path of the Soap directory if not
already correct.
• Scroll Down and Hit Save.
Configuration Maintenance
Managing SearchConfig.xml
The brain of the federated search operation is the SearchConfig.xml so it is essential that
Server Administrators keep this file up to date. The Server Administrators must collaborate
with other Server Administrators from other locations of any changes to their environments.
Not updating the file will cause locations not to be found causing an invalid search request.
*Important: When adding an existing location to the SearchConfig.xml, the location name
entry must match the existing location name entry of the destination location. This means that
if the location name “Bartlesville” exists, then when adding this location to the configuration
file the location name must also be “Bartlesville” and not “Bville”. This allows Federated
Search to standardize a location name throughout the enterprise.
Managing searchserver.xml
The searchserver.xml needs to be up to date per location. The Server Administrators does not
need to collaborate with other Server Administrators for other locations on this configuration
file. This file only pertains to the location and will not affect other locations.
*Important: The searchserver.xml should only contain one entry, the entry for the current
location.
Security Maintenance
Page 18/19
• The Component Services Console will appear. Expand Component ServicesComputers
MyComputerCOM+ Applications.
• Right-click on the SPSSearchService Application and select Shut Down. This temporarily
shuts the the application to make changes.
• Right-click on the SPSSearchService Application and select Properties.
• Under the Identity Tab, update the user account as necessary.
• After updating the information, you may restart the package by right-clicking on the
SPSSearchService Application and select Start. The package will automatically start on
first use, so it is not necessary to start.
*Note: Any configuration changes made to the COM+ Application will require the user to enter
the Identity Account Password to propagate changes.
*Note: If user is an administrator on the server, he will have access to all workspaces even
though he is not configured to by the SharePoint Portal Server Administrative console. The
local server admin rights will override the SharePoint Portal Server security rights.
Page 19/19