windows desktop search administration guide 3 revb

1

Windows Desktop Search 3.01

Administration Guide

The information contained in this document represents the current view of Microsoft Corporation on

the issues discussed as of the date of publication. Because Microsoft must respond to changing

market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and

Microsoft cannot guarantee the accuracy of any information presented after the date of publication.

This White Paper is for informational purposes only. MICROSOFT MAKES NO WARRANTIES, EXPRESS,

IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS DOCUMENT.

Complying with all applicable copyright laws is the responsibility of the user. Without limiting the

rights under copyright, no part of this document may be reproduced, stored in or introduced into a

retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying,

recording, or otherwise), or for any purpose, without the express written permission of Microsoft

Corporation.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual

property rights covering subject matter in this document. Except as expressly provided in any

written license agreement from Microsoft, the furnishing of this document does not give you any

license to these patents, trademarks, copyrights, or other intellectual property.

Unless otherwise noted, the companies, organizations, products, domain names, e-mail addresses,

logos, people, places, and events depicted in examples herein are fictitious. No association with any

real company, organization, product, domain name, e-mail address, logo, person, place, or event is

intended or should be inferred.

© 2007 Microsoft Corporation. All rights reserved.

Microsoft, MS-DOS, Vista, Windows, Windows NT, Windows Server, ActiveX, Excel, FrontPage,

InfoPath, IntelliSense, JScript, OneNote, Outlook, PivotChart, PivotTable, PowerPoint, SharePoint,

ShapeSheet, Visual Basic, Visual C++, Visual C#, Visual Studio, Visual Web Developer, and Visio are

either registered trademarks or trademarks of Microsoft Corporation in the United States and/or

other countries.

All other trademarks are property of their respective owners.

License Agreement

Windows Desktop Search 3.01 Administration Guide


2

TABLE OF CONTENTS

WINDOWS DESKTOP SEARCH 3.01 1

ADMINISTRATION GUIDE 1

WINDOWS DESKTOP SEARCH 3.01 ADMINISTRATION GUIDE 2

Last Updated 26 Sept, 2007........................................................................................3EXECUTIVE SUMMARY....................................................................................................4UNDERSTANDING THE DIFFERENCES BETWEEN WINDOWS VISTA AND WINDOWS XP WITH WDS. .4WINDOWS DESKTOP SEARCH (WDS) ENTERPRISE DEPLOYMENT CHECKLIST.............................5PRE-INSTALLATION CONSIDERATIONS................................................................................6

System Requirements..........................................................................................6Security & Privacy................................................................................................7Group Policy.........................................................................................................9Providing Enterprise-Specific Defaults..................................................................9International Options..........................................................................................10Enterprise Search Integration.............................................................................10Using WDS and Microsoft Outlook\Exchange......................................................11Network Performance.........................................................................................12Roaming User Profiles........................................................................................12Terminal Servers................................................................................................12

INSTALLING WINDOWS DESKTOP SEARCH........................................................................13Installation Package...........................................................................................13WDS Migration Plans..........................................................................................14

VERSION COMPARISON & OS........................................................................................15INSTALLATION CONSIDERATIONS....................................................................................15

Upgrading Versions............................................................................................15WDS Software Updates.......................................................................................16Version History Table.........................................................................................16Installing International Versions.........................................................................19Adding Functionality with MSN Search Toolbar...................................................20Deployment Modes.............................................................................................20Installer command-Line Options.........................................................................21Deploying WDS by Using Group Policy...............................................................22Wrapping WDS into an MSI Wrapper..................................................................22

WINDOWS DESKTOP SEARCH EXTENSIBILITY AND PROGRAMMABILITY....................................26File Types and Indexing......................................................................................27

CUSTOMIZING WDS BY USING GROUP POLICY..................................................................28Group Policy Overview........................................................................................28Obtaining the WDS .adm template for Windows Group Policy............................29Windows Search Policy Location.........................................................................29General Policy Setting Behavior.........................................................................30Adhering to System Policies...............................................................................31Windows Search Policies....................................................................................31WDS 3.01 ADM Template for Windows XP and Windows Server 2003...............32

Prevent indexing when running on battery power to conserve energy.........................32Prevent customizing indexed locations in the Control Panel.........................................33Allow using diacritics.....................................................................................................33Prevent displaying advanced indexing options in the Control Panel.............................33Prevent indexing files in Offline Files cache..................................................................33Prevent Indexing uncached Exchange Folders..............................................................33Prevent indexing Microsoft Office Outlook....................................................................33Prevent indexing e-mail attachments............................................................................34Control Rich Previews for Attachments.........................................................................34Prevent indexing public folders.....................................................................................34Indexer data location.....................................................................................................34


3

Add Primary Intranet Search Location...........................................................................34Add Secondary Intranet Search Locations.....................................................................35Preview Pane location....................................................................................................36Set Large or Small icon View in Desktop Search Results...............................................36Stop Indexing on Limited Hard Drive Space..................................................................36Prevent Unwanted IFilters and Protocol Handlers..........................................................37Do not allow web search...............................................................................................37Prevent Indexing Certain Paths.....................................................................................37Default Indexed Paths...................................................................................................38Default Excluded Paths..................................................................................................38Prevent Indexing of Certain File Types..........................................................................38

Windows Search Policies that ship with Windows Vista......................................39Allow Indexing of encrypted files...................................................................................39Allow using diacritics.....................................................................................................40Indexer data location.....................................................................................................40Prevent indexing e-mail attachments............................................................................40Prevent indexing files in Offline Files cache..................................................................40Prevent indexing Microsoft Office Outlook....................................................................40Prevent indexing public folders.....................................................................................40Prevent Indexing uncached Exchange Folders..............................................................40Prevent displaying advanced indexing options in the Control Panel.............................41

ADDITIONAL INFORMATION AND RESOURCES 41

WDS SUPPLEMENTAL LICENSE TERMS............................................................................41SUPPORT...................................................................................................................41TROUBLESHOOTING WDS.............................................................................................41ADDITIONAL LINKS......................................................................................................48

Document revision history 48

Last Updated 26 Sept, 2007

This document is provided for informational purposes. Microsoft makes no warranties, express or

implied, with respect to this document or the information contained in it. In addition, this should be

considered a living document and as such readers should check back to the online version located at

Microsoft TechNet for any updates that may have taken place since the time this document was

created. This document targets an audience of IT managers and administrators and pertains to

Windows Desktop Search 03.01 and later versions for Windows™ XP, Windows™ Server 2003 and

Windows Vista™ operating systems.

The latest version of the technology is WDS 03.01.6000.72 (Microsoft Knowledge Base article

917013). In this paper, WDS 03.01.6000.72 is referred to as WDS 3.01. WDS 3.01 is an update to

WDS 03.00.0000 which is referred to as WDS 3.0. WDS 3.01 is available via Windows update for

Windows XP SP2 and Windows Server 2003. Windows Vista has WDS 3.x indexing technology built

directly into the OS, but uses a new User Interface to surface the integrated search functionality.

This document will attempt to differentiate between functionality between XP/Server and Vista.

Note Some features are not available in all markets.

Executive SummaryWindows Desktop Search (WDS) is the search technology that lets users quickly find almost anything

on their computers, including e-mail messages, calendar appointments, photos, documents, and


http://support.microsoft.com/default.aspx/kb/917013

4

more. In WDS 3.x, the search engine is now a system service but it retains the desktop performance

features of previous versions of WDS. WDS 3.x has been optimized in its integration into Vista to

give a superior experience compared to WDS on older machines. WDS uses simple search syntax to

search for information that the user has selected to index. This means that when a user types

“email from:john date:yesterday”, WDS will list all e-mail messages that the user received

yesterday from anyone named John. Users familiar with search syntax can use advanced keywords

(Advanced Query Syntax) to specify everything from file types to date ranges as well as specifying

which folders to search in. WDS returns results in a rich Windows Explorer environment, so users can

quickly preview, filter, and act on search results.

WDS is designed to minimize performance impact on the user’s computer. WDS works in the

background to maintain its index. When first installed, it scans selected locations to build the initial

index. After that, it uses system or application notifications to index new or changed content. When

items are deleted, the corresponding entries in the index are also deleted.

WDS is optimized so that enterprise information technology (IT) managers can deploy and easily

manage the installation of WDS across all of the users and computers in their organizations. It is

simple to integrate WDS with enterprise resources or other enterprise search solutions such as

Microsoft SharePoint Portal Server or Microsoft Windows SharePoint Services (WSS). The technology

is designed to be secure, and users can only see content to which they have access. In addition,

WDS is designed to have minimal impact on network performance.

No information about your searches or the files on your computer will be sent to Microsoft. Instead,

WDS will index the content of your computer and store the index file on your computer. Desktop

search will not store information about documents or e-mail once they have been deleted.

Top of page

Understanding the Differences Between Windows Vista and Windows XP with WDS

The indexing engine that is part of WDS 3.0 and later is already part of Windows Vista and thus

there is no need to install WDS on Windows Vista machines. All Ifilters and Protocol handlers that

work with WDS 3.x will also work with Windows Vista because of this shared indexing engine. Ifilters

and Protocol handlers are what the indexer uses to index files and other data stores like e-mail.

Windows ships with a number of default IFilters and protocol handlers. Windows Vista has a search

and organization offering that is more fully featured than that of WDS 3.01. Windows Vista includes

fast desktop search, but goes beyond search to also provide rich, intuitive file organization

capabilities. Some of these capabilities include: support for Live Icons, file tagging, Search Folders,

and advanced navigation - all of which enables customers to flexibly organize and view their files in

virtually any way they wish. You can read more about these Windows Vista features here. Notably,

enterprises will be pleased that Windows Vista has the ability to index files that are taken “Offline”

or cached locally. There are also some differences in policies that apply to WDS versus Windows

Vista. These differences are called out in the Group Policy section below.

Windows Desktop Search (WDS) Enterprise Deployment Checklist


http://www.microsoft.com/windows/products/windowsvista/features/details/instantsearch.mspx

5

Getting Started

Read the WDS Administration Guide.

Check corporate system standards to ensure that they meet or exceed minimum system

requirements for WDS for the target platform.

Research and Preparation

Determine users indexing needs:

o Local system level (My Documents, e-mail, and other folders).

o Departmental information that may be available on other network shares or sites.

o Security and access to data (determine if shares or network resources would need

to be blocked from some users and made available to others).

o Network bandwidth or high usage resources (how to best alleviate any possible

issues with access to these network resources).

o Determine if your organization requires any international versions or uses

Multilingual User Interface (MUI) Packs.

Download Windows Desktop Search (WDS 3.01).

This download contains the following components:

Windows Desktop Search software (version 3.01).

o Windows Desktop Search: Add-in for Files on Microsoft Networks. This is now built

into WDS 3.01 and there is no need to install it in addition to WDS.

Windows Desktop Search ADM (DesktopSearch30.adm) template file to enable Group Policy

settings (for XP and Server 2003 only, Vista group policies ship with the OS). For more

information about group policies see the Group Policy Overview section.

Pre-Pilot Testing

Test in a controlled test environment using your company’s standard system image that

includes the operating system and commonly installed software, resources, and back end.

Review the user requirements analysis and test results to determine the best practices and

to plan a pilot test. Choose one department or a small group of users for the pilot test.

Pilot Testing

Begin a pilot test program and monitor the following for any problems or issues:

o Deployment methodology

o Network load

o Server loads

o Software conflicts

o User requirements and comments

o Any unexpected errors or issues

o User expectations of indexing

o Requirements for helpdesk and end-user training to assure efficient uptake and

support

Act on lessons learned, as follows:

o Document successes and challenges.

o Resolve and document any outstanding issues.

o Revise your deployment plan, policies, access to resources, and other items as

required.

o Create and document a plan for corporate deployment.


6

Note If Indexer performance shows an abnormally high consumption of system resources

and takes a long time to build the initial index, it may be due to an anti-virus program

running on the target platform. Consider evaluating this problem by either re-testing with

the Anti-virus temporarily turned off or Windows Desktop Search’s .exe excepted in a

controlled, protected environment. It is likely your anti-virus vendor has already resolved

any interoperability issues in an update.

Enterprise-Wide Deployment

Determine deployment methodology.

Prepare the deployment package.

Create and then deploy policies for departments and users according to company policy,

user requirements, and best practices.

Deploy Windows Desktop Search in accordance with the deployment and training plans.

Top of page

Pre-Installation ConsiderationsBefore installing Windows Desktop Search, an administrator must consider several factors, including

the following:

System requirements

Security and privacy

o Index Security

o Index Content

o Index Encryption

Group Policy

Providing enterprise-specific defaults

International options

Enterprise search integration

Impact to Exchange Servers where mail is kept online

Network performance – potential bandwidth impact where small data pipes exist

Terminal Servers

In this section, we will look at these issues and discuss methods that you can use to manage these

situations so that you have a successful and painless rollout.

System RequirementsThe minimum system requirements to run Windows Desktop Search are:

32-bit versions of Microsoft Windows XP with Service Pack 2 (SP2)

All x64-based versions of Windows XP

Microsoft Windows Server 2003 with Service Pack 1 (SP1)

All x64-based versions of Windows Server 2003

Windows Terminal Services must be running. (This is the default configuration for windows,

but some security scenario lock down this service. To use WDS, Terminal service must be

running.)

Microsoft Outlook XP and Outlook Express 6.0 are the earliest versions of mail clients

supported for indexing and searching mail with WDS.

Note Outlook XP must be in Corporate or Workgroup mode. Outlook 2003 and 2007 is

recommended to be in cached mode.


7

Microsoft Office XP or later versions for full preview of Microsoft Office documents in

Desktop Search results.

A Pentium 500 megahertz (MHz) processor or better (A Pentium 1 gigahertz (GHz) processor

is recommended).

A Minimum of 256 megabytes (MB) of RAM (512 MB of RAM is recommended).

In addition, we recommend that computers have at least the following:

500 MB of hard disk space.

Note Your index size depends on the amount of content you are indexing. Typically, the

index will account for 10-12 % of the data it is indexing.

1024 x 768 screen resolution.

Top of page

Security & PrivacyMost IT and business managers agree that security is a high priority for their companies and for their

users. Windows Desktop Search complies with the Windows Security model and is subject to

frequent review. WDS has taken significant steps to help ensure the security of the index file. WDS

runs as a system service; however, a user can only search for what he or she has access to. The

WDS service does security trimming to make sure that a user cannot access any data they do not

have permission to see.

Index Security

WDS does not make the computer’s content accessible to Microsoft or anyone else by default. In

Windows Vista there is a capability to query remote Vista computers, but this only works if the data

is shared and the user has access to the shared data. In WDS 3.x there is one index created per

machine no matter how many users utilize the machine. If the user does share a computer with

other users, each user can search only their own files and the files in shared locations. Users cannot

search documents that are saved in another user’s ‘My Documents’ folder unless those areas are

specifically shared by the owner or by another user who has administrator rights to the computer.

WDS installs the index in a protected area on the hard disk. By default, each user to the machine

contributes to the same index:

%systemdrive%\Documents and Settings\All Users\Application Data\Microsoft\Search\Data\(Windows XP)

%systemdrive%\ProgramData\Microsoft\Search\Data\ (Windows Vista)

Index Content

If you are an administrator, you can use Group Policy to prohibit specific paths or file types from

being indexed. WDS indexes information as follows:

WDS by default will index each user’s e-mail and default Documents and Settings folders. In

addition, the user can elect to include all other local hard disks. The Add-in for Files on

Microsoft Networks is part of WDS 3.01 and allows the user to specify custom locations

such as network shares, but none are selected by default.

WDS does not index sensitive information, such as the Internet cache or office password

files.

WDS indexes mail and attachments in a secure environment. Indexing of mail attachments

can be turned off by using Group Policy.


8

The WDS service keeps itself up to date automatically in the background, including the

modification and deletion of data. This means there is no need for the user to rebuild the

index manually to keep it up to date.

The WDS index is obfuscated by default, but can be strongly encrypted by using the

Windows Operating Systems encryption options.

By using Group Policy, you can quickly and easily allow or block the indexing of various paths, file

types, and other content. For detailed information about how to use Group Policy with Windows

Desktop Search, see the Customizing WDS by using Group Policy section.

Encrypting Your Index

By default, the WDS index is obscured so that it is not easily readable if someone tries to open the

index file. To strongly encrypt the WDS index, use the Encrypting File System (EFS). The EFS

provides the core file encryption technology that is used to store encrypted files on NTFS file system

volumes. The EFS helps protect files from intruders who might gain unauthorized physical access to

sensitive, stored data (for example, by stealing a portable computer or an external disk drive). For

more information about EFS, visit the following Microsoft Web site:

http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/

encrypt_overview.mspx?mfr=true

To encrypt the index, follow these steps:

1. Create a new folder for the catalog (for instance, %systemdrive%\Documents and Settings\

All Users\Application Data\Microsoft\Search\EFSSearch).

2. Right mouse click on the new folder. Select Properties from the context menu. Click the Advanced button. Select the “Encrypt contents” checkbox in the dialog.

3. Open up the indexing options dialog from WDS. Click the advanced button. Use the option to move the index to a new folder. Specify the folder you just encrypted.

4. Reset the service (searchindexer.exe) or reboot to move it to the new location.a. To reset the service open compmgmt.msc using the run box.b. Select the Services and Applications node.c. Select services.d. Find the “Windows Search” service and double click on it.e. Under Service Status there will be a button to Stop the service.f. Hit the Stop button.g. Once the service is successfully stopped, hit the start button. h. At this point the service has been successfully restarted.

5. The index has now been moved and is now encrypted and usable.

Note While you can encrypt the WDS index, WDS 3.01 does not currently support indexing EFS files

and folders for Windows Server 2003 or Windows XP even though the control panel presents a

grayed out option to do so. To index items with EFS, you will need to install WDS 2.66 which does

support indexing EFS items. Windows Vista does support indexing EFS files that are available via

Offline files and indexing drives that have BitLocker drive encryption turned on. Windows Vista does

not support indexing items that have been encrypted via EFS outside of Offline Files.

Top of page

Group Policy


http://support.microsoft.com/?kbid=926356

http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/encrypt_overview.mspx?mfr=true

http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/encrypt_overview.mspx?mfr=true

9

By using Group Policy and setting up Group Policy Objects (GPO), network administrators can

administer software from a central location and release changes to the user community at one time.

Various policies are available to help you set up options, configure indexing, and configure search

behaviors. Group Policy can be used to configure default system settings that the user can change.

Group Policy can also be used to enforce specific user settings that the user cannot change. Group

Policy is supported by WDS 3.01 and Windows Vista.

To plan and deploy effective policies, your organizational units and groups must be logically

structured. The benefits of a well-planned and implemented organizational structure are far-reaching

in the management of security, users, and resources. Organizational structure can be extremely

beneficial when you plan how to most effectively deploy WDS. It is likely that different organizations

in your company will have very different requirements for the availability of information and

resources. For example, the accounting department may have access to more systems and require

more security than the shipping and receiving department.

As in most software deployments, the more time that you spend organizing and planning how to

best meet the different requirements of your users, the better the outcome will be. With WDS, you

can tailor the product for each group so that the product searches different resources.

By using Group Policy, you can quickly and easily add to or limit the resources and functionality of

WDS. For detailed information about how to use Group Policy with Windows Desktop Search, see the

Customizing WDS by using Group Policy section.

Top of page

Providing Enterprise-Specific DefaultsIf you enable a forced computer policy by selecting Windows Search from the Computer

Configuration tree in the Group Policy Object Editor, the user cannot change these setting. If the

user tries to change the setting, the setting is typically not visible or is unavailable. The user may

also receive an error message. However, in certain business scenarios, the IT administrator may

want to change only the out-of-box default settings to provide enterprise-specific defaults that the

user can later change.

For example, consider the following scenario. WDS can index any network resource that the user

adds to the scope of WDS. However, for business reasons you prefer not to index all network

resources, but you don’t mind providing a choice so that users who really want to index a network

resource can do so. Therefore, you can enable the ‘Default Indexed Paths’ and ‘Default Excluded

Paths’ policies with your preferences, which the user will be able to modify via the user options.

In general, WDS uses the following logic to determine the precedence of settings:

If a computer policy exists, use the computer policy.

If a user preference exists, use the user preference.

If no computer policy or user preference exists, use the computer preference.

Top of page

International OptionsWDS currently supports 33 languages. If your organization requires international versions, you can

either deploy the specific international versions of WDS, or you can deploy the Multilingual User


10

Interface (MUI) pack which contains the English version of WDS. Users of the MUI pack can switch

user interfaces according to their language preference.

WDS is available in the following language installers:

Chinese Simplified German Portuguese

Chinese Traditional Greek Portuguese (Brazilian)

Czech Hungarian Russian

Danish Italian Spanish

Dutch Japanese Swedish

English Korean Turkish

Finnish Norwegian

French Polish

The MUI pack enables WDS to search in the following languages:

Bulgarian Estonian Japanese Portuguese

(Brazilian)

Swedish

Chinese Simplified Finnish Korean Romanian Thai

Chinese Traditional French Latvian Russian Turkish

Croatian German Lithuanian Serbian - Latin Ukrainian

Czech Greek Norwegian Slovak

Danish Hungarian Polish Slovenian

Dutch Italian Portuguese Spanish

You can use the English .adm file to create Group Policy Objects (GPO) for international users. For

settings that require you to enter text, such as the name of the intranet scope, enter the information

in the appropriate language.

Top of page

Enterprise Search IntegrationFor Windows XP SP2 and Windows Server 2003, WDS provides policies that allow the IT

administrator to specify a primary intranet search location and any number of secondary intranet

search locations to virtually any type of enterprise search solution. Once these policies are applied,

users can start intranet searches from within the Windows Deskbar and the WDS results view.

Examples of enterprise search solutions include Microsoft Share Point Portal Server and Windows

SharePoint Services (WSS).

Your users can benefit as follows:

Users can easily start an intranet search from the Windows Deskbar or the WDS results

view.

Users can easily switch between search results from the desktop, the intranet, and the Web

from the Desktop Search results view.

Additionally, Web searches can be initiated from WDS. The default Web search provider is picked up

from your users default browser. If you prefer not to allow your users to search the Web from within

WDS, a policy is in place that allows you to disable this feature.


11

For more information about Group Policy options, see the Windows Desktop Search Policies section.

Top of page

Using WDS and Microsoft Outlook\ExchangeFinding items in e-mail has been a concern for business people for many years. The hard part is

finding a way to keep a current index of all e-mail messages and attachments without excessively

taxing the mail server. WDS supports Outlook indexing in both cached and uncached mode.

However, WDS 3.01 must be configured via Group Policy to index e-mail when cached mode is

turned off (Note, this is different from WDS 2.6x which indexed online content by default).

With Microsoft Office Outlook 2003 and later running in cached mode, WDS simply searches the e-

mail messages and attachments that are stored locally on the user’s computer. By default, WDS not

only indexes e-mail messages, but also indexes attachments. In this configuration, Outlook receives

new e-mail and other information from the Exchange server and saves the data in a mail store file

on the local computer. WDS checks this mail store for new items and indexes the new items from

this file. This type of indexing eliminates extra load on the Exchange server and reduces the network

bandwidth that client index services would ordinarily need to search the e-mail server.

In environments that are running Exchange 2000 or later, WDS reduces the time and load on

Exchange by reducing the number of Remote Procedure Calls (RPC) that are made to the server

when e-mail messages and attachments are indexed. Also, because e-mail messages are indexed in

native formats such as HTML, Rich Text Format (RTF), or text, the server requires no conversion of

mail types. Therefore, the overhead associated with indexing mail on the server is greatly reduced.

WDS has also been designed to index public folders only when they are cached locally.

There are additional Group Policy options available that can be used to manage the impact on

Exchange while still allowing your users to index the information they require. For more information

about Group Policy options, see the Windows Desktop Search Policies section.

Microsoft Office Outlook 2003 and later versions can be configured via group policy to either

explicitly enforce or prohibit Cached Mode. To do this you will need to use the Outlook .adm file to

configure the policy. Once the .adm file is installed, go to Microsoft Office Outlook <Version>->

Tools-> E-mail Accounts-> Cached Exchange Mode. The two policies that are relevant are “Disable

Cached Exchange Mode on New Profiles” and “Cached Exchange Mode (File | Cached Exchange

Mode)”. Neither policy is configured by default. To learn more about Outlook and configuring group

policy, download the Outlook Resource Kit (ORK) for the version of Outlook you are using.

If your environment is running WDS 3.x and Microsoft Outlook with “Cached Mode” disabled, then

you will need to use group policy to make WDS index users’ mail since it talks directly to the

Exchange Server and WDS is configured by default not to index content on the exchange server. To

enable WDS to index data on the Exchange Server, you must set “Prevent Indexing uncached

Exchange Folders” policy to disabled and then push the policy via a group policy update.

Network PerformanceIt is often desirable to allow users to index network shares and other resources. For Windows XP and

Windows Server 2003, the ability to index remote shares is integral to the WDS 03.01 installation


12

package. In the scenario where data or e-mail resides only on the network, this flexibility may come

at a cost. Enabling users to index network shares may increase the network traffic to these locations

while the users’ systems are indexing them. The most impact will be seen during the build-up of the

initial index. Less impact will be seen during incremental updates of the index. Impact on servers is

mitigated by the back-off functionality built into WDS.

By using Group Policies, you can modify various aspects of the product to help limit the impact on

network traffic while still allowing your users to index the information they require access to. An

example of a policy available for managing network performance includes disabling certain network

paths to high volume servers.


Top of page

Note In Windows Vista, a user’s Offline Files cache is indexed. Therefore, another way to limit network performance with Windows Vista is to have users take files offline so they can be indexed locally.

Roaming User ProfilesWDS 3.x works with Roaming User Profiles. However, each desktop will maintain a shared index for

all users to that computer. The system index does not move with the user so it is likely when a user

logs into a machine for the first time, the data in his profile will need to be reindexed.

Top of page

Terminal ServersWindows Desktop search can be supported on terminal servers. However, there are a couple of

issues to be aware of when using WDS on a terminal server:

When there are many users on the system simultaneously, the following may occur:

o Indexer performance is reduced because it is backed off more often. For example,

one user may be idle, but another user may generate a lot of CPU usage or I/O.

o System performance may be affected, particularly in cases where users click “Index

Now”.

We recommend that IT departments test these scenarios before they deploy WDS.

Top of page

Installing Windows Desktop SearchThe WDS installer is based on the Windows package installer technology (formerly called

Update.exe). The Package Installer installs software updates for Microsoft Windows operating

systems and Windows components. If you are an IT administrator and are interested in learning

more about the package installer, visit the following Microsoft Web site:

The Package Installer (Formerly Called Update.exe)

Windows Desktop Search must be installed by a user who has administrator permissions on the

computer. If you are prompted to restart your computer after you install WDS as part of a stand-

alone installation or upgrade, we recommend that you do restart the computer.


http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideUpdateCommand

13

Note When you uninstall WDS, users may receive a warning that some programs may rely on WDS

and could fail to function if the uninstall is completed. The warning is generated because WDS was

installed by using Windows package installer technology (Update.exe). The Windows package

installer keeps track of all the programs that it installs. When a user tries to uninstall one of those

programs, Update.exe generates a generic warning. This warning lists the programs that were

installed by Update.exe after the installation of the program that you are removing. This is done to

allow users to consider the possible dependencies between programs before completing an uninstall

process. Our testing has shown that such dependencies do not exist between WDS and other

programs. You can continue to uninstall WDS without complications.

For more information about Update.exe, visit the following Microsoft Web site:

The Package Installer (Formerly Called Update.exe)

Top of page

Installation PackageWDS is released as a software package in a single, self-executing file. The file name of the WDS

installation package resembles the following:

WindowsDesktopSearch-KB917013-V301-XP-x86-XXX.exe

In the file name, XXX is the placeholder for the language code. For example,

WindowsDesktopSearch-KB917013-V301-XP-x86-enu.exe is the file name of the U.S. English

installation package. The installation package name changes with each release of the product.

Specifically, the “KB” number in the file name changes to reflect the Knowledge Base article that is

associated with the release. This number may change or be completely removed from the filename.

In an enterprise environment, WDS is typically deployed to multiple desktop computers across an

organization by using one of the following deployment tools:

System Management Server (SMS)

Group Policy Software Installation

Non-Microsoft third-party deployment software

When WDS is installed, a shortcut is added to the Start menu and to the taskbar of all users of the

computer. The Windows Deskbar is automatically made available on all users’ taskbars. WDS, as a

service, runs automatically on the computer whenever the computer is switched on. One index is

maintained per computer. Shared data, for example, stored on local drives is only indexed once. In

addition, each individual user’s data is added to the index and distinguishable by way of the {SID}

which is a unique identifier for each user. Each individual user maintains their own search

parameters.

In some cases, the WDS 3.01 might not install correctly if your registry is corrupted. For more

information about repairing the registry to allow WDS to install read the following Knowledge Base

Article.


http://support.microsoft.com/kb/919163/en-us



14

Top of page

What’s Included

WDS 3.01 includes the following major components:

WDS Indexer – Indexes more than 200 file types and content stores.

Windows Deskbar – Provides a search-as-you-type interface to quickly locate items on your

desktop.

Desktop Search results view – Provides a search results view that lets you easily preview,

filter, and act on search results.

Search companion integration – Upgrades the Search Companion or Search Assistant in the

Windows operating system.

Indexing options (Control panel applet) – Lets you specify what to index, where to index,

and more.

Windows Desktop Search – Add-in for Files on Microsoft Networks. This is no longer a

separate add-in.

Windows Desktop Search ADM – Template file to enable Group Policy settings.

Note Windows Vista contains the WDS indexer, indexing control options, a new UI to allow search,

and Group Policy settings.

Top of page

WDS Migration Plans

Microsoft has two versions of Windows Desktop Search (WDS) that work on most Windows computers. The newest version is WDS 3.01 which Microsoft Office 2007 integrates with to add enhanced search capabilities. For older operating systems or mixed environments, WDS 2.6.6 provides most of the same benefits. Both versions provide the necessary tools for deploying and managing the software across your organization.

Version Comparison & OS

VistaWinXP

SP2 WinXP SP1Win 2000

SP4WinSvr 2003

Win XP/WinSvr 64-bit

Office 2007 Built-in 3.01 Not Supported

Not Supported

WDS 3.01 WDS 3.01

Office 2003 Built-in WDS 3.01 WDS 2.6.6 WDS 2.6.6 WDS 3.01 WDS 3.01Office XP Built-in WDS 3.01 WDS 2.6.6 WDS 2.6.6 WDS 3.01 WDS 3.01

Installation ConsiderationsCurrent WDS Deployment Recommended Action

None Highest version based on above table2.6.5 Upgrade to WDS 2.6.62.6.6 Migrate to 3.01 with Office 2007 deployment 3.0 Upgrade to WDS 3.01

Table 2

Note

1. If using EFS, deploy 2.6.6 until it is supported. 2. Migrating from WDS 2.6.x to WDS 3.x code base requires a complete rebuild of the desktop

search index.


15

3. To initiate searches from within Microsoft Office Outlook 2003/XP/2000, you can use Windows Live Toolbar or MSN Search Toolbar. If Group Policy support is required then you will need the MSN Search Toolbar version 02.06.

4. MSN Toolbar is disabled within Microsoft Office Outlook 2007 since the functionality is already a part of Microsoft Office Outlook 2007

5. The ability to add UNC files shares to index is not supported on 64bit versions of Windows.

Upgrading VersionsWDS version 3.x and later will upgrade 2.6.x versions of WDS. However, WDS versions 2.5000.1119

or earlier, which are typically installed as a suite along with MSN Search Toolbar, should ideally be

uninstalled before installing a newer version of WDS. These older versions can be uninstalled by

using remote system management. There is no need to install or update computers running

Windows Vista.

If you upgrade from WDS 2.5 to 3.01, WDS 2.5 will be automatically uninstalled and 3.01 will be

installed after the successful uninstall of 2.5. No settings migrate from WDS 2.5 to WDS 3.01. Once

WDS 3.01 is installed it will have to completely rebuild the index.

If you upgrade from WDS 2.6 to 3.01, WDS 2.6 will be automatically uninstalled and 3.01 will be

installed after the successful uninstall of 2.5. No settings migrate from WDS 2.6 to WDS 3.01. Once

WDS 3.01 is installed, it will have to completely rebuild the index. In addition, any 3rd party or

Microsoft add-ins will need to be reinstalled.

If you upgrade from WDS 3.0 to 3.01, the upgrade will preserve the index and any scopes you have

configured. If the add-in for files on Microsoft Networks (UNC/FAT PH) is installed with WDS 3.0, it

will get automatically uninstalled, but it will be reinstalled with WDS 3.01 since it is included in WDS

3.01 package itself. All the other 3rd party protocol handlers (like IE History) installed before

upgrade will continue to work as expected.

Note Uninstalling the MSN toolbar suite and installing WDS 3.x or later does not restore MSN Search

Toolbar functionality. If the MSN Search Toolbar is still required after WDS is installed, visit the

following Microsoft Web site to download and install the latest version of Toolbar:

MSN Search Toolbar (for Enterprise deployment)

To find the version of WDS that is installed on your computer, go to your Control Panel and click

Add or Remove Programs. Find the entry for Windows Desktop Search and select Click here

for support information. The version number is listed in the Support Info box.

For WDS version information, see the Version History Table.

Top of page

Note If you have upgraded from WDS 3.0 to 3.01 and then choose to uninstall WDS 3.01, the

uninstaller will indicate that WDS 3.0 is being uninstalled. However, uninstall process will remove

both WDS 3.01 and 3.0 binaries.


http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideTBarCorpSite

16

WDS Software UpdatesNetwork administrators must be able to manage and control the versions of the applications they

support. To make this easier, WDS is fully supported by Microsoft Update. However, there are

several methods that can be used to obtain the latest version of WDS:

Search for updates by using the optional downloads on the Microsoft Update site.

Search for updates at the following Microsoft Web site:

http://www.microsoft.com/windows/desktopsearch.

Search for updates in the Microsoft download center.

You can have more control if you use Microsoft Systems Management Server or other deployment

technologies for updates.

Top of page

Version History Table

WDS version Release date

Notes

03.01.6000.72 March 25,

2007

This release includes the following changes:

Group Policy support to make WDS 3.X align with 2.6.x

policies

ADM template for 3.01 included in installation package

Add-in for Files on Microsoft Networks in default

installation package

Performance and Watson improvements

03.00.0000 October 24,

2006


Architectural overhaul to make WDS a system service

Better support for the multi-user environment

Consolidation to 1 index per machine

02.06.6000.5414 November

28, 2006


When using “Prevent Indexing of Uncached Exchange

Folders” policy, previously indexed content is cleared

after the policy is applied.

When using “Specify Location of Windows Desktop Search

Index” policy, UNC or mapped network drives can now be

specified as destinations for the index.

Fix to the preview of XML file types.

Fix to ensure the index updates successfully when you

add/move/delete e-mails as it relates to third party

protocol handlers.

Added a new policy to hide the web search button.

Added a new policy to allow bandwidth throttling of the

Indexer.


http://www.microsoft.com/windows/desktopsearch

17


Notes

General performance improvements for the initial

indexing process.

The updated .adm template file is available at the enterprise

search download location and is included in the Enterprise

Components Pack.

The release is documented in Microsoft Knowledge Base article

926356.

Note After you install this version, users with WDS 2.6.5.5378 and

earlier versions must rebuild their indexes. Only users with WDS

2.6.5.5401 will not be required to rebuild their index.

02.06.5000.5401 May 30, 2006 This hotfix release includes the following changes:

Change to enable the use of roaming profiles

Fix to “Prevent Indexing Certain Paths” to include not

only the path root but its hierarchy, and to prevent users

from adding unauthorized paths

Fix to “Prevent Indexing Exchange Server” to preserve

user’s settings if the policy is enabled and then later

disabled

Change to let network administrators disable the user

customization of search locations in Index Options

Added a new policy to Prevent User Defined Locations.

The updated .adm template file is available at the enterprise

search download location.

The hotfix is documented in Microsoft Knowledge Base article

917979.

Note After you install this fix, users must rebuild their indexes.

02.06.5000.5378 April 13,

2006


Added three new policies:

Index certain paths

Prevent indexing certain paths

Disable rebuild index button

Made significant performance improvements, including virtual

elimination of shutdown delay, stability improvements, and the

addition of full support through Microsoft Update.




18


Notes

This version is documented in Microsoft Knowledge Base article

911993.

Also resolved issues requiring users to uninstall previous versions

of WDS before installing version 2.6.5 or a later version.

02.06.0000.2083 January 4,

2006


Fixed issues in which some e-mail messages are not indexed.

Documented in Microsoft Knowledge Base article 907371. The

package installer is renamed with “V2” in the filename.

You must uninstall earlier versions of WDS before you install this

version.

02.06.0000.2057 November

14, 2005


First enterprise-class release with support for Group Policy. First

documented in Microsoft Knowledge Base article 907371. You

must uninstall earlier versions of WDS before you install this

version.

02.05.0001.1119 September

27, 2005


Toolbar suite installed with WDS.

02.05.0000.1082 June 20,

2005


WDS Suite installed with Deskbar and Toolbar.

Top of page

Installing International VersionsIf your organization requires international versions of WDS for users who speak different languages,

you can deploy localized versions of WDS. This is recommended unless support for multiple

language users is required for a single computer. For this scenario, you can download and deploy

the Multilingual User Interface (MUI) pack which includes the English version of WDS. The MUI pack

lets your users switch user interfaces based on the language preference. To use the WDS MUI pack,

the Windows MUI pack must already be installed.

Note There is no need to install the WDS MUI for Windows Vista. Once a language pack for Windows

Vista is installed and setup, search will automatically use it.

Top of page

Installing Windows Desktop Search MUI Pack





19

The Windows Desktop Search MUI pack works together with the Windows MUI pack. Therefore, you

must install the Windows MUI pack before you install the WDS MUI pack. When you change the

default language of the Windows, WDS will also update to use the same language.

For best results, use the following steps when installing WDS and the WDS MUI pack:

1. Install the Windows MUI pack.

2. Install the WDS MUI pack (which includes the installation of WDS).

3. Change the Windows Regional and Language options:

a. In the Regional and Language Options item in Control Panel, click the

Languages tab.

b. In the Languages used in menus and dialogs list, choose the language you

want, and then click OK.

4. Log off and then log on as the same user.

The WDS user interface uses the language you selected in Regional and Language Options.

To download the MUI pack, visit the following Web site:

Windows Desktop Search downloads

For more information about the Windows MUI pack, visit the following Microsoft Web site:

http://www.microsoft.com/globaldev/reference/win2k/setup/default.mspx

Top of page

Adding Functionality with MSN Search ToolbarIf you are interested in providing desktop search entry points in Microsoft Office Outlook 2003 or

Microsoft Internet Explorer, you need to deploy the MSN Search Toolbar separately. MSN Search

Toolbar adds a new toolbar to Internet Explorer and a new toolbar to Outlook. Both toolbars let users

perform a desktop search if WDS is installed. MSN Search Toolbar also provides features that

optimize corporate deployments. For more information, visit the following Microsoft Web site:

MSN Search Toolbar (for Enterprise deployment)

If you are interested in providing a desktop search entry point in Microsoft Office Outlook 2007 or

later versions, the MSN Search Toolbar is not required as WDS 3.x is the underlying indexing engine

which powers the Instant Search functionality in these versions.

Top of page

Deployment ModesWDS can be deployed in attended mode or unattended mode, depending on the level of interaction

you want your users to have with the computer during the installation. Installations for both modes

can be performed through a combination of command-line options. For a full list of supported

command line options, visit the following Microsoft Web Site:

Package installer command-line options




http://www.microsoft.com/globaldev/reference/win2k/setup/default.mspx

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideMUI

20

Note To test command-line options and the behavior of the installation package, click Start, click

Run, type CMD in the Open box, and then click OK. Locate the installer package, and then test the

installer package with various options. We recommend that you uninstall WDS before you install

again with different command-line options.

Top of page

Attended Mode

Attended mode is the typical installation method for an individually managed environment that

requires end-user interaction. If you plan to make WDS available on-demand by using an internal IT

software download site, you can deploy WDS in attended mode.

In this mode, the Software Update Installation Wizard is started. Your end users must accept the

end-user license agreement (EULA) and exit open applications when they are prompted to do so.

Your end users must restart their computers, as necessary, at the end of the installation process.

By default, WDS installs in attended mode when no command-line options are specified.

Unattended Mode

Unattended mode enables the automated installation of software updates. This mode does not

require end-user interaction. If you specify the /quiet or /q command-line option, the WDS

installation is completely silent. If a restart is required, the restart occurs automatically. The WDS

Deskbar appears automatically after the unattended installation is complete.

You can also specify the /passive or /u command-line option. These command-line options provide

you with a progress bar and inform the user if a restart is necessary. The user must opt into the

restart though. Additionally, passive mode installation will display any errors that may occur.

If Outlook is running while WDS is being installed in unattended mode, Outlook does not exist as part

of the installation process. The WDS installation process continues. However, indexing of e-mail does

not start until you exit and then restart Outlook.

There are several ways to accomplish unattended installation. These include developing custom

batch installations by using the previously mentioned command-line options. Or, you can use

automation software, such as SMS or Windows Update Services, to install software updates on all

the computers in a network.

If you manually install a software update, the installation runs in the user context. You should be an

administrator who has the user permissions that are specified in the “Required User Right” section

of the package installer documentation. If a software update is deployed by using SMS or Windows

Update Services, the package installer runs in the System context, because the parent process runs

as a service.

Top of page

Installer command-Line Options


21

Command-line Options Description

/quiet or /q Provides no status dialog box during the extraction. Unless used

together with /extract or /extract:path, this option directs the

installation to run in quiet mode.

/passive or /U Provides a progress bar during the extraction, but does not prompt you

for the destination folder name. Unless used together with /extract or

/extract:path, this option directs the installation to run in passive

mode.

Note This requires user interaction if a restart is required.

/extract or /X Extracts package files without starting the installation. Prompts you for

the path of the destination folder for extraction. When used together

with the /q or /U switch, this option extracts the package file to a

randomly named folder on the root folder.

/extract:path_name or

/X:path_name

Extracts software update package files to the specified folder without

starting the package installer or prompting you for a destination folder.

When used together with the /q or /U switch, this option extracts the

package file to the specified folder.

Top of page

Deploying WDS by Using Group PolicyYou cannot directly deploy package installer-based or update.exe-based Windows components by

using Group Policy. If you need to use Group Policy, you must write a deployment wrapper, such as

an MSI package, that contains the WDS executable file. The package installer and the Windows

Installer are not interchangeable. Packages that are built with one installer technology have been

tested and optimized to work only with that technology.

Note Modification of the software package may result in its failure to operate properly. Microsoft

does not support customers’ repackaging software updates with a different installer. This would

include modifying the current update.exe package headers, files, or installation information to

conform to another deployment method. Simply placing the package in a “wrapper,” such as an MSI

wrapper, is acceptable. For instructions, see the Wrapping WDS Into an MSI Wrapper section.

Top of page

Wrapping WDS into an MSI Wrapper Microsoft does not guarantee that WDS will install correctly or function correctly when you install

WDS from an MSI wrapper that was not written by Microsoft. However, we provide the following

steps so that you can create an MSI wrapper for the WDS Setup program.

Note To follow these steps, you must know how to prepare a general MSI package. The sample code

is provided as-is, without any warranties. Error-checking in the code has been mostly omitted.


22

1. Author WDSSetup.exe into the Binary table of your MSI package. If you are editing the .wxs

files directly, add a line that resembles the following:

<Binary Id= “WindowsDesktopSearch.exe” src= “path to WDSSetup.exe on the

build machine”/>

2. Author the command-line properties for how WDSSetup.exe will run. For example, to run

the WDSSetup.exe file in a quiet mode and to suppress the potential post-setup restart, add

the following line to the .wxs file:

<Property Id=”WDSCOMMANDPARAM” Value=” "/quiet /norestart" />

3. In your custom action DLL, add actions that stream the WDS installer from the MSI package

and that start the MSI package. The following code is sample C++ code that you can use to

do this:

#include <windows.h>#include <Msiquery.h>#include <TCHAR.h> // A helper method to retrieve the necessary entries from the Property table of the MSI.LPTSTR GetProperty(MSIHANDLE hInstall, LPCTSTR lpProperty, PDWORD pdwSize){ LPTSTR lpValue = NULL; bool bRet = true; DWORD dwSize=0; UINT uResult = MsiGetProperty(hInstall, lpProperty, TEXT(""), &dwSize); if (ERROR_MORE_DATA == uResult) { *pdwSize = ++dwSize; lpValue = (LPTSTR) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, dwSize*sizeof(TCHAR)); if (NULL != lpValue) { uResult = MsiGetProperty(hInstall, lpProperty, lpValue, &dwSize); if (ERROR_SUCCESS != uResult) { HeapFree(GetProcessHeap(), 0, lpValue); lpValue = NULL; } } } return lpValue;} // This routine streams the WDSSetup.exe file from the MSI package.UINT __stdcall StreamOutWDSPackage(MSIHANDLE hInstall){ UINT uRes = 0; TCHAR szTempPath[MAX_PATH]; TCHAR szTempFile[MAX_PATH]; TCHAR szCommandLine[MAX_PATH]; HRESULT hr; ZeroMemory(szTempPath, sizeof(szTempPath)); // Obtain path of the temporary directory. DWORD dwRes = GetTempPath(MAX_PATH, szTempPath); ZeroMemory(szTempFile, sizeof(szTempFile)); // Generate a fully qualified temporary file name that has the prefix “WDS.” if (dwRes) uRes = GetTempFileName(szTempPath, TEXT("wds"), 0, szTempFile); if (!dwRes || !uRes) {


23

// Add code for logging the failure if needed. return ERROR_INSTALL_FAILURE; } //Add .exe extension to the name of the temporary file. hr = StringCchPrintf(szTempFile, MAX_PATH, TEXT("%s.exe"), szTempFile); if (FAILED(hr)) { // Add code for logging the failure if needed return ERROR_INSTALL_FAILURE; } // Obtain the Windows Desktop Search setup command-line parameters property. DWORD dwSize; LPTSTR lpCommandParam = GetProperty(hInstall, TEXT("WDSCOMMANDPARAM"), &dwSize); if (NULL == lpCommandParam) return ERROR_INSTALL_FAILURE; // Create the command-line command that includes the directory path, the command name, and the parameters. ZeroMemory(szCommandLine, sizeof(szCommandLine)); hr = StringCchPrintf(szCommandLine, MAX_PATH, TEXT("\"%s\" %s"), szTempFile, lpCommandParam); // Free lpCommandParam because we don't need it anymore. if (lpCommandParam) HeapFree(GetProcessHeap(), 0, lpCommandParam); if (FAILED(hr)) return ERROR_INSTALL_FAILURE; // Create the actual temporary file and then obtain its handle. The code uses // the handle to write data to this file. HANDLE hFile = 0; hFile = CreateFile(szTempFile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL); if (INVALID_HANDLE_VALUE == hFile) { // Add code for logging the failure if needed. return ERROR_INSTALL_FAILURE; } // Send the handle to the MSI database. PMSIHANDLE hDB; hDB = MsiGetActiveDatabase(hInstall); if (NULL == hDB) { // Add code for logging the failure if needed return ERROR_INSTALL_FAILURE; } // A query to retrieve the WDS Setup file from the MSI package. PMSIHANDLE hView; if (ERROR_SUCCESS != MsiDatabaseOpenView(hDB, TEXT("SELECT `Data` FROM `Binary` WHERE `Name` = 'WindowsDesktopSearch.exe'"), &hView) || ERROR_SUCCESS != MsiViewExecute(hView, 0)) { // Add code for logging the failure if needed. return ERROR_INSTALL_FAILURE; } // Fetch data from query result. PMSIHANDLE hRec; uRes = MsiViewFetch(hView, &hRec); if (uRes != ERROR_SUCCESS) { // Add code for logging the failure if needed.


24

return ERROR_INSTALL_FAILURE; } // Extract binary data from Windows Desktop Search setup record. char szBuff[MAX_BUFFER*2]; DWORD dwBuffSize; DWORD dwBytesWritten; do { // Extract binary data to buffer. dwBuffSize = MAX_BUFFER*2; uRes = MsiRecordReadStream(hRec, 1, szBuff, &dwBuffSize); if (ERROR_SUCCESS != uRes) { // Add code for logging the failure if needed. break; } if(dwBuffSize) { // Write the chunk of the binary data to disk. if ( !WriteFile(hFile, szBuff, dwBuffSize, &dwBytesWritten, NULL) ) { // Add code for logging the failure if needed. break; } } } while (dwBuffSize > 0); CloseHandle(hFile); // This will store the command line into the CustomActionData, to be // later retrieved by the InstallWindowsDesktopSearch action. uRes = MsiSetProperty(hInstall, TEXT("InstallWindowsDesktopSearch"), szCommandLine); if (ERROR_SUCCESS != uRes) { // Add code for logging the failure if needed. } return uRes;} // This routine retrieves the command line that will launch the WDS Setup file and starts // an install helper.UINT __stdcall InstallWindowsDesktopSearch(MSIHANDLE hInstall){ UINT uRes = ERROR_SUCCESS; DWORD dwSize; LPTSTR lpCommand = GetProperty(hInstall, TEXT("CustomActionData"), &dwSize); if ( lpCommand && dwSize > 0) { uRes = LaunchWDSSetup(hInstall, lpCommand); } else uRes = ERROR_INSTALL_FAILURE; HeapFree(GetProcessHeap(), 0, lpCommand); return uRes;} // A helper that launches the WDS Setup file.UINT LaunchWDSSetup(MSIHANDLE hInstall, LPTSTR lpCommandLine){ STARTUPINFO startInfo; ZeroMemory(&startInfo, sizeof(STARTUPINFO)); startInfo.cb = sizeof(STARTUPINFO); startInfo.dwFlags |= STARTF_USESHOWWINDOW; startInfo.wShowWindow = SW_SHOW; // or SW_HIDE, if you want a silent install PROCESS_INFORMATION procInfo;


25

ZeroMemory(&procInfo, sizeof(PROCESS_INFORMATION)); if(CreateProcess(NULL, lpCommandLine, NULL, NULL, TRUE, //inherit handles CREATE_NO_WINDOW, // no window NULL, //inherit environment NULL, //inherit current dir &startInfo, &procInfo)){ HANDLE hProcess = procInfo.hProcess; WaitForSingleObject(hProcess, INFINITE); CloseHandle(procInfo.hThread); CloseHandle(procInfo.hProcess); } else { // Report error } return ERROR_SUCCESS;}

4. Author the actions that you added to the custom action DLL into the Custom Action table.

Then, author the custom action DLL into the Binary table if it is not there yet. The action

would resemble the following in a scenario in which the custom action DLL is Ca.dll:

<Binary Id="CA.dll" src=”path to ca.dll” />

<CustomAction Id="StreamOutWDSPackage" BinaryKey="CA.dll"

DllEntry="StreamOutWDSPackage" Return="ignore"/>

<CustomAction Id="InstallWindowsDesktopSearch" BinaryKey="CA.dll"

DllEntry="InstallWindowsDesktopSearch" Execute="deferred"/>

Note The execution of the InstallWindowsDesktopSearch [function] is deferred because it modifies

the target system, so the function runs at the end of the sequence. A benefit of delaying when the

function runs is that the InstallWindowsDesktopSearch [function] has to obtain the command line for

starting the WDS Setup program through the CustomActionData private property (see the custom

action code above).

5. Finally, appropriately schedule your custom actions into the Install Execute sequence. The

exact sequencing depends on the other tasks you want the MSI package to do. Here is an

example:

<InstallExecuteSequence>

<LaunchConditions/>

<InstallInitialize/>

…

<Custom Action="StreamOutWDSPackage" After="InstallInitialize” />

<Custom Action="InstallWindowsDesktopSearch" After="StreamOutWDSPackage”/>

…

</InstallExecuteSequence>

Windows Desktop Search Extensibility and Programmability


26

You can extend WDS with protocol handlers, property handlers, and filters to enable indexing of

additional data stores and file types. Extending WDS in this way enables you to perform the

following tasks:

Search additional file types that WDS does not index by default, such as Adobe PDF files or

IBM Lotus Notes files.

Search additional data repositories from third-party applications, such as your customer

relationship management (CRM) database.

Integrate search results into your third party applications, such as importing new Outlook

contacts into your CRM system.

After you download an add-in and the computer is idle, the new file types are indexed. For a list of

supported add-ins and third party filters and protocol handlers that can be integrated with WDS, visit

the following Microsoft Web site:

Windows Desktop Search Add-ins

Alternatively, you can create your own add-ins. For more information about how to extend WDS by

creating your own protocol handlers, property handlers or filters, visit the following Microsoft Web

site:

Windows Desktop Search developer guide

Top of page

File Types and IndexingWDS has a filter to index virtually any file type as text including the file name, the metadata, and

the contents of the file. Inherently, WDS indexes some popular file types as text and excludes

others, as described below. Users can change these defaults on the on the File Types tab in the

Advanced Options dialogue from the Indexing options control panel applet. For additional control,

IT administrators can also prevent certain file types from being indexed via policy.

Ifilters are required to index popular file types in the correct format. These Ifilters include those that

are already in Office and that let you index, view, and search file names, metadata, and the contents

of .doc or .xls files. In addition, more custom file types can be interpreted and viewed in your

preferred format when you create Ifilters or protocol handlers. For file attachments, only base file

types are inherently enabled for preview in the WDS results window. For additional control, the IT

administrator can specify via policy additional file types that are allowed to be previewed via the

WDS results window.

By default, the following file types are indexed as text:

.a;.ans;.asc;.asm;.bas;.bat;.bcp;.c;.cc;.cls;.cmd;.cpp;.cs;.csa;.cxx;.dbs;.def;.dic;.dos;.dsp;.dsw;.ext;.fa

q;.fky;.h;.hpp;.hxx;.i;.ibq;.dl;.idq;.inc;.inf;.ini;.inl;.inx;.jav;.java;.js;.kci;.lgn;.log;.lst;.m3u;.mak;.map;.m

db;.mk;.odh;.odl;.pl;.prc;.rc;.rc2;.rct;.reg;.rgs;.rul;.s;.scc;.sol;.sql;.tab;.tdl;.tiff;.tlh;.tli;.trg;.txt;.udf;udt;

.usr;.vbs;.viw;.vspscc;.vsscc;.vssscc;.wri;.wtx

By default, the following file types are excluded from the index:


http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideWDSDev

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideAddins

27

.386;.aps;.bin;.bk1;.bk2;.bkf;.blf;.bsc;.btr;.cat;.cfg;.cgm;.chk;.ci;.crwl;.cur;.dat;.dbg;.dct;.dir;.dl_;.el;.e

vt;.ex_;.exp;.eyb;.fnt;.fon;.ghi;.gthr;.hqx;.icm;.idb;.idx;.ilk;.imc;.in_;.ini;.inv;.ipp;.jbf;.lib;.local;.log;.log

1;.log2;.m14;.mac;.man;.manifest;.map;.MAPIMail;.mmf;.mui;.muimanifest;.mv;.ncb;.obj;.oc_;.ocx;.o

necache;.onetoc;.onetoc2;.ost;.pch;.pdb;.pds;.pf;.pic;.pma;.pmc;.pml;.pmr;.pst;.res;.rmp;.rpc;.rsp;.sb

r;.sc2;.sit;.sr_;.sy_;.sym;.tlb;.tlh;.tmf;.tmp;.ttc;.ttf;.ufm;.vbx;.vxd;.wll;.wlt;.xbm;.xix;.z96;.ZFSendToTa

rget

The following policy may be of interest:

Prevent Indexing of Certain File Types: Lets you edit the list of file types that you want to

exclude from indexing.


Customizing WDS by Using Group Policy

Group Policy OverviewWDS 3.01 fully supports Group Policy. Administrators can use Group Policy to deliver and apply one

or more preferred configurations or policy settings to a set of targeted computers within an Active

Directory® service environment. The administrative template files (.adm files) provide the available

policy settings and are designed to modify specific keys in the registry. This method is known as

registry-based policy. You will need to obtain the WDS .adm file to configure and enforce certain

WDS settings by using Group Policy. WDS 3.01 only supports machine based group policy. This is

different from WDS 2.66.

The following is a summary of the steps that you must take as a Group Policy administrator to

configure WDS with Group Policy:

1. Create an environment that supports the efficient application of Group Policy.

This step concerns the design of the Active Directory domain, sites, and organizational

units. Precisely how you implement this step depends on the administrative structure of

your company.

2. Create a Group Policy object that contains the appropriate policy settings.

By using the Active Directory management console or the Group Policy Management

Console (GPMC), you can create and edit your Group Policy object (GPO) to contain one or

more policy settings for WDS and for any other applications that use Group Policy. At this

stage, no users or computers are affected by the GPO.

3. Scope the GPO.

Before the GPO is linked, you can fine-tune which computers are affected by using security

filtering that specifies which Active Directory security groups should receive the GPO. Or,

you can use Windows Management Instrumentation (WMI) filtering that allows you to select

a wide range of client-side criteria to decide whether the GPO should be applied. You would

do this to make sure this GPO only applies to a subset of computers instead of all computers

in Active Directory.

4. Link a GPO to a Scope of Management.

A Scope of Management (SOM) is an Active Directory domain, site, or organizational unit. As

soon you link the GPO to an SOM, the GPO affects all computers and users in that SOM.

For more information about Group Policy, visit the following Microsoft Web site:


28

http://technet2.microsoft.com/windowsserver/en/technologies/featured/gp/default.mspx

Top of page

Obtaining the WDS .adm template for Windows Group PolicyTo obtain the WDS .adm file, extract the contents from the WDS 03.01 package (this applies only to

XP or Windows Server 2003) using the package extract command /extract and locate the file in the

“update” subfolder at the location where the package was extracted to.

To import the .adm file into the Microsoft Management Console (MMC), follow these steps:

1. Start the MMC. To do this, click Start, click Run, type mmc in the Open box, and then

press ENTER.

2. Start the Group Policy Editor:

a. Click File.

b. Click Add/Remove Snap-in.

Click Add.

c. Select Group Policy.

d. Click Add, click Finish, click Close, and then click OK.

3. Load the DesktopSearch30.adm file into the Group Policy Object Editor:

a. Under Console Root, click Computer Configuration.

b. Right-click the Administrative Templates folder, and then click Add/Remove

Templates.

Click Add.

c. Locate and then click the DesktopSearch30.adm file.

d. Click Open, and then click Close.

e. Under Administrative Templates, expand the Windows Components node

followed by the Windows Search node.

4. Save these settings for later use. To do this, click File, click Save As, type

DesktopSearch.msc, and then click Save.

Note Windows Vista already has group policy support for search. Therefore, you do not need to add

a template. The search policies are under computer configuration->Administrative templates-

>Windows components->Search.

Top of page

Windows Search Policy LocationAll policies are created under the following section of the registry:

HKLM\Software\Policies\Microsoft\Windows\Windows Search

Note Windows Search adds a sub key to the location in which Windows Search policy settings

reside.

A key is added to the policy section only when a policy is applied. Therefore, if no policies are

applied, the key is not present.

Top of page


http://technet2.microsoft.com/windowsserver/en/technologies/featured/gp/default.mspx

29

General Policy Setting BehaviorAll Windows Search policy settings will be described in detail. However, in general, WDS policies

share the following attributes:

Real-time refresh.

As soon as the policy is applied and WDS receives a notification of the policy change, WDS

automatically refreshes to enforce the settings. The user does not need to exit and restart

the application or log on to Windows again for the new policy to take effect. For some

policies, the settings may be in effect when the policy is pushed out. However, for indexing

related policy settings, the information currently indexed may not be restricted or added

until the next time the user logs on or the next indexing session occurs.

Index purges for most indexing related policy settings.

If you enable policies to prevent the indexing of certain content, such as Outlook data, the

index is automatically cleared and rebuilt at the next startup of Outlook or the computer.

For example, if you decide to prevent Outlook indexing for business specific, regulatory, or

compliance reasons after the initial deployment, applying the policy and restarting Outlook

(or the computer) ensures that Outlook data that has already been indexed is cleared. The

only exceptions are policies that specify which files to index as text and policies that specify

which file types to exclude. If you subsequently modify these policies, the content that has

already been indexed is not cleared.

WDS policies fall into three categories:

Setup and configuration

Include certain information, paths, or types of data

Exclude certain information, paths, or types of data

In WDS, the forced “prevent” policies take precedence over the user option selections, which in turn

take precedence over the default “exclude”, “include” and “setup” policies. Because of this

precedence, some policies and combination of polices with user preferences may conflict. For

example, a “Default Indexed Paths” policy whose value points to a certain key network share may

be overridden by a user option to include this path for indexing. Similarly, this policy may conflict

with a “Prevent Indexing Certain Paths” policy that keeps users from accessing any other network

resources. This combination of two conflicting policies would block the user from indexing any

network share despite the “Default Include” policy. Therefore, administrators must take the time to

think through and test their Group Policy scenarios, along with the user options they want to allow,

before they deploy the policies to end users.

Top of page


30

Adhering to System PoliciesWDS is built on common Windows components. Therefore, WDS adheres to system-level policies

that your organization may have enabled. There are two specific system-level policies that are

relevant to the Windows Deskbar.

Remove the Run command from Start menu

Description When this policy is enabled, the system removes the Run command from the Start

menu. It also prevents users from opening the Run dialog box by pressing the Windows

logo key and the R key.

Application action If an application has a function that allows a user to start a program by typing its name

and path in a dialog box, the application must disable that functionality when this policy

is enabled.

WDS Behavior Automatically turns off the alias feature in Windows Deskbar.

Automatically turns off run operation (=operation) in Windows Deskbar.

Automatically removes the My Deskbar Shortcuts section from Deskbar.

Note This only applies to Windows XP and Windows Server 2003. There is not a

Deskbar in Windows Vista

Run only allowed Windows-based applications

Description When this policy is enabled, users can run only those applications that are listed under

the RestrictRun value.

Application action An application must not start any application that is not on this list. However, this does

not apply when you start applications by using COM. If you use the ShellExecuteEx

function, the system performs this check automatically.

WDS Behavior Windows Deskbar only starts applications that are on the Restrict Run list.

Note This only applies to Windows XP and Windows Server 2003. There is not a

Deskbar in Windows Vista.

Top of page

Windows Search Policies This section outlines all the policy settings that are available for WDS. The policies are arranged as

they are listed in the .adm file.

Below are the policies for the WDS client. The WDS 3.01 adm template is meant to control

functionality on Windows XP and Windows Server 2003 for WDS 3.01. Some of these policies are

also included by default in the Windows Vista group policy settings. A list of policies that are

applicable to Windows Vista are also below. The primary difference in the policies is that the

Windows Vista UI is different than the WDS UI.

The policy structure between WDS 3.01 and WDS 2.66 are different. To manage an environment

that has both WDS 3.01 and WDS 2.66 you will need to use both ADM templates. The WDS 2.66


http://msdn.microsoft.com/library/en-us/shellcc/platform/shell/reference/functions/shellexecuteex.asp

31

policies do not apply to 3.01 or vice versa. This is because there was a major architecture change

between these two versions. WDS 3.01 is the first effort at taking the policies that were

implemented in WDS 2.66 and moving them forward to the new WDS 3.x platform. Some policies

have been carried forward, but not all of them. The largest difference between WDS 2.66 and WDS

3.01 is that WDS 3.01 policies are all per machine instead of all per user like in WDS 2.66.

Note Even when Group policy is forced onto a user or computer it can still take up to 10 minutes for

it to take effect. In cases where you are applying group policy to WDS UI, it can also be delayed for

up to the amount of time it takes for policy to deploy. If a delay does happen, it would only happen

when the related group policy is being updated.

WDS 3.01 ADM Template for Windows XP and Windows Server 2003Prevent indexing when

running on battery

power to conserve

energy

Prevent customizing

indexed locations in

the Control Panel

Allow using diacritics Prevent displaying

advanced indexing

options in the Control

Panel

Prevent indexing files

in Offline Files cache

Prevent Indexing

uncached Exchange

folders

Prevent Indexing

Microsoft Office

Outlook

Prevent indexing e-

mail attachments

Control Rich Previews

for Attachments

Prevent indexing

public folders

Indexer data location Add Primary Intranet

Search Location

Add Secondary

Intranet Search

Locations

Preview Pane location Set Large or Small Icon

View in Desktop

Search Results

Stop Indexing on

Limited Hard Drive

Space

Prevent Unwanted

IFilters and Protocol

Handlers

Do not allow web

search

Prevent Indexing

Certain Paths

Default Indexed Paths

Default Excluded Paths Prevent Indexing of

Certain File Types

Top of page

Policy Setting Description

Prevent indexing when running on battery power to conserve energy

If enabled, the indexer pauses whenever the computer is running on battery. If disabled,

the indexing follows the default behavior. This policy is disabled by default.

OS: Windows XP, Windows Server 2003

Note On Windows Vista, the indexer automatically backs of on low power.

Prevent customizing indexed locations in the Control Panel

If enabled, Search and Indexing Options control panel applet does not allow opening the

modify locations dialog; otherwise, it can be opened. Disabled by default.



32


Allow using diacritics

This policy setting allows words that contain diacritic characters to be treated as

separate words. If you enable this policy setting, words that only differ in diacritics are

treated as different words. If you disable this policy setting, words with diacritics and

words without diacritics are treated as identical words. This policy setting is not

configured by default. If you do not configure this policy setting, the local setting,

configured through the control panel, will be respected.

Note By default, the control panel setting is set to treat words that differ only because

of diacritics as the same word.

OS: Windows XP, Windows Server 2003, Windows Vista

Prevent displaying advanced indexing options in the Control Panel


advanced options dialog; otherwise, it can be opened. Disabled by default.


Prevent indexing files in Offline Files cache

If enabled, files on network shares made available offline are not indexed; otherwise,

they are indexed. Disabled by default.

Note This is a Windows Vista only policy

OS: Windows Vista only

Prevent Indexing uncached Exchange Folders

Enabling this policy prevents indexing of mail items on a Microsoft Exchange server

when Microsoft Outlook is run in uncached mode. The default behavior for WDS 3.01 is

to not index uncached exchange folders.

Note This is the default behavior and so for uncached Exchange items to be

indexed this policy must be disabled. Versions of Outlook prior to 2003 do not

support cached mode and so only local items such as PST files will be indexed if this

policy is enabled or left in the not configured state.


Prevent indexing Microsoft Office Outlook

Enable this policy to prevent indexing of any Microsoft Outlook items. The default is to

automatically index Outlook items. If this policy is enabled, the user’s Outlook items will

not be added to the index and the user will not see them in search results.


Prevent indexing e-mail attachments

Enable this policy setting to prevent the indexing of the content of e-mail attachments.

If enabled, indexing service components (including the ones from 3rd parties) are

expected not to index e-mail attachments. Consider enabling this policy if you are

concerned about the security or indexing performance of 3rd party document filters

(iFilters). This policy is disabled by default.


33



Control Rich Previews for Attachments

Enabling this policy defines a semi-colon delimited list of file extension which will be

allowed to have rich attachment previews. When this policy is disabled or not configured

the default settings will be set to .bmp; .emf; .gif; .jpg; .jpeg; .png; .wmf.


Prevent indexing public folders

Enable this policy to prevent indexing public folders in Microsoft Office Outlook. When

this policy is disabled or not configured, the user has the option to index cached public

folders in Outlook. Public folders are only indexed when using Outlook 2003 or later. The

user must be running in cached mode and the Download Public Folder Favorites option

must be turned on.


Indexer data location

Store indexer database in this directory. This directory must be location on a local fixed

drive.


Add Primary Intranet Search Location

Enabling this policy lets you add a primary intranet search location within WDS. The

value of this text should be:

name,url

You must provide the following:

A name for the scope, such as “Intranet”.

The URL to the search service. Use $w in place of the query term for the search

service URL.

If your intranet search service is SharePoint Portal Server, your query should resemble

the following:

http://sitename/Search.aspx?k=$w

If your intranet search service is Windows SharePoint Services (WSS), the query should

resemble the following:

http://sitename/_layouts/XXXX/searchresults.aspx?SearchString=$w

Note Replace the XXXX placeholder with the locale ID of your WSS intranet search

service. For example, the English locale ID is 1033.

Enabling this policy adds the intranet search location to the following:

Windows Deskbar

Desktop Search results search box

WDS search box in Search Companion


34



Add Secondary Intranet Search Locations

Enabling this policy lets you add other intranet search locations along with the primary

intranet search location defined in the Add Primary Intranet Search Location policy. The

value of this text should resemble the following:

name1,url1;name2,url2;...nameN,urlN

Examples:

Intranet,http://intranetsearch.aspx?k=$w

MySearch,http://mysearch.aspx?q=$w;MySearch2,http://mysearch2?q=$w

Note Add no spaces after the comma between the name and the URL. Adding any

spaces after the comma makes your URL invalid.

For each search scope, provide:

1. A name for the scope, such as “IT Web.”

2. The URL to the search service. Use $w in place of the query term for the search

service URL.

If your intranet search service is SharePoint Portal Server, your query should resemble

the following:

http://sitename/Search.aspx?k=$w

If your intranet search service is Windows SharePoint Services (WSS), the query should

resemble the following:

http://sitename/_layouts/XXXX/searchresults.aspx?SearchString=$w

Note Replace the XXXX placeholder with the locale ID of your WSS intranet search

service. For example, the English locale ID is 1033.

Enabling this policy adds the secondary intranet locations to the following:

The All Locations list in the Desktop Search results.

The WDS search box in Search Companion.


Preview Pane location

Enabling this policy allows you to set the location of the preview pane in the Desktop

Search results. You can also turn off the preview pane. The four options are:

- Auto

- Right

- Bottom


35


- Off

You should consider enabling this policy to turn off the preview pane if your

environment does not support Office XP or later. The full preview pane functionality is

only available for Office documents in Office XP or later.

When this policy is disabled or not configured, the preview pane shows automatically to

the right of the Desktop Search results. Your users can choose the location of the

preview pane.


Set Large or Small icon View in Desktop Search Results

Enabling this policy allows you to specify whether you want large icon or small icon view

for your Desktop Search results. The two options are:

Large Icon

Small Icon

If you have disabled the preview pane because your organization does not support

Office XP or later versions of Office, you should enforce the large icon view so that users

can see snippets related to their desktop search query.

When this policy is disabled or not configured, the default view is the small icon view.


Stop Indexing on Limited Hard Drive Space

Enabling this policy prevents indexing from continuing when less than the specified

amount of hard disk space remains on the disk on which the index is located. Specify

between 0 and 2147483647 MB.

Enable this policy if computers in your environment have extremely limited hard disk

space.

When this policy is disabled or not configured, WDS automatically manages your index

size.

Note Indexing status does not indicate that indexing has stopped due to the

enforcement of this policy.


Prevent Unwanted IFilters and Protocol Handlers

Enabling this policy prevents Windows Desktop Search from using IFilters and Protocol

Handlers unless they are specified in the "allow" list. However, this policy will not

prevent IFilters or Protocol Handlers from being installed, nor will it prevent them from

being used by other applications or services.

You can also specify an allow list of add-ins by providing the classID or ProgId string. For

example, if you plan to deploy a particular ifilter, make sure that this ifilter is on the

allow list, either as a GUID such as "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" (include


36


the braces) or a COM ProgID such as "VisFilter.CFilter.1".

If you maintain a locked desktop environment, this setting is redundant because non-

administrative users do not have permission to install new components. If your users

have Administrator permissions or can install software, this policy prevents them from

specifically using Windows Desktop Search-related add-ins.

Note Because of a limitation in the Group Policy editor, you must add at least one entry

in the allow list. You must have at least one entry, even if you want to enable this policy

without an allow list. Create a list entry by putting a space in the name field and a space

in the value field and then save it. This will create a placeholder entry that is ignored by

the program.


Do not allow web search

Enabling this policy removes the option of searching the Web from Windows Desktop

Search.

When this policy is disabled or not configured, the Web option is available and users can

search the Web via their default browser search engine.


Prevent Indexing Certain Paths

Enabling this policy allows you to specify a list of paths to exclude from indexing. The

user cannot enter any path that starts with one of the paths you specified.

If you enable and then disable this policy, users can index any path not restricted by

other policies, but their original list of paths to index is not restored.

The format of the paths URLs are:

Protocol://site/path/file

An example of a local machine path is file:///C:\*

An example of a network share is otfs://{*}\server\path\*

Note Any path based policy has certain limitations. Both the default inclusion and

exclusion path policies have the same restrictions as below.

Path specified should be contained within a 256 character limit. If the 256 character

limit is exceeded, any paths specified after the long path will be ignored.

“*” should always be used after any path is specified to denote all possible paths under

the given location.

Any path specified in group policy will show up in the indexing UI, even if it is an invalid

path.

To prevent indexing of Outlook Express you need to add an entry in this policy for

outlookexpress://{*}


37



Default Indexed Paths

Enabling this policy allows you to specify a list of paths to index by default. The user

may override these paths and exclude them from indexing.




An example of a network share is

otfs://{*}/<servername>/<path>/*

otfs://localhost/<drive>/<path>/* (for the <drive> part it should be specified as “c” not

“c:\”

Note You would only use this with a local drive if it were a FAT drive instead of NTFS.


Default Excluded Paths

Enabling this policy allows you to specify a list of paths to exclude from indexing by

default. The user may override these paths and include them in indexing.




An example of a network share is ofts://{*}/server/path/*


Prevent Indexing of Certain File Types

Enabling this policy allows you to edit the list of file types to exclude from indexing. The

end user cannot modify this list. You should separate each extension type with a

semicolon.

Note that limitations of Group Policy Object editor require this list to be split across

multiple values. Desktop Search combines all these into a single exclusion list.

When this policy is disabled or not configured, the user can edit the default list of

excluded file types. If you enable and then disable this policy, the user’s original list is

restored. Also, when the policy is enabled it only blocks the capability to index a certain

file type. In the advanced control panel, the file type will still be selectable although

selecting a disabled file type will have no effect. Usually, this policy is deployed in

conjunction with the Prevent displaying advanced indexing options in the Control Panel

policy.


Top of page

Windows Search Policies that ship with Windows Vista


38

Allow Indexing of

encrypted files

Allow using diacritics Indexer data location Prevent indexing-email

attachments

Prevent indexing files

in Offline Files cache

Prevent Indexing

Microsoft Office

Outlook

Prevent indexing

public folders

Prevent Indexing

uncached Exchange

Folders

Prevent displaying

advanced indexing

options in the Control

Panel


Allow Indexing of encrypted files

The ability to index encrypted items that have been encrypted via EFS is only available

for items that have been made available to work offline using “Offline Files”. This is

typically seen with Folder Redirection. WDS 3.01 cannot index local file system items

that have been encrypted with EFS.

This policy setting allows encrypted items to be indexed. If you enable this policy

setting, indexing disregards encryption flags (access restrictions still apply though) and

will attempt to decrypt and index the content. If you disable this policy setting, the

search service components (including the ones from 3rd parties) are expected not to

index encrypted items such as emails or files, and to avoid indexing encrypted stores.

This policy setting is not configured by default. If you do not configure this policy

setting, the local setting, configured through the control panel, will be respected.

Note By default, the control panel setting is set to not index encrypted content.

Note Enabling this policy setting will not allow encrypted files in the local file system to

be indexed.

Note SKUs of Windows Vista that have the BitLocker drive encryption feature will be

indexed without any group policy settings. The Bitlocker and indexing technology work

seamlessly.

Allow using diacritics

This policy setting allows words that contain diacritic characters to be treated as

separate words. If you enable this policy setting, words that only differ in diacritics are

treated as different words. If you disable this policy setting, words with diacritics and

words without diacritics are treated as identical words. This policy setting is not

configured by default. If you do not configure this policy setting, the local setting,

configured through the control panel will be respected.

Note By default, the control panel setting is set to treat words that differ, only because

of diacritics, as the same word.

Indexer data location

Store indexer database in this directory. This directory must be location on a local fixed

drive.

Prevent indexing Enable this policy setting to prevent the indexing of the content of e-mail attachments.


39


e-mail attachments

If enabled, indexing service components (including the ones from 3rd parties) are

expected not to index e-mail attachments. Consider enabling this policy if you are

concerned about the security or indexing performance of 3rd party document filters

(iFilters). This policy is disabled by default.

Prevent indexing files in Offline Files cache

If enabled, files on network shares made available offline are not indexed; otherwise,

they are indexed. Disabled by default.

Prevent indexing Microsoft Office Outlook

Enable this policy to prevent indexing of any Microsoft Outlook items. The default is to

automatically index Outlook items. If this policy is enabled, the user’s Outlook items will

not be added to the index and the user will not see them in search results.

Prevent indexing public folders

Enable this policy to prevent indexing public folders in Microsoft Office Outlook. When

this policy is disabled or not configured, the user has the option to index cached public

folders in Outlook. Public folders are only indexed when using Outlook 2003 or later. The

user must be running in cached mode and the Download Public Folder Favorites option

must be turned on.

Prevent Indexing uncached Exchange Folders

Enabling this policy prevents indexing of mail items on a Microsoft Exchange server

when Microsoft Outlook is run in uncached mode. The default behavior for WDS 3.01 is

to not index uncached exchange folders.

Note This is the default behavior and so for uncached items to be indexed this

policy must be disabled. Versions of Outlook prior to 2003 do not support cached

mode and so only local items such as PST files will be indexed if this policy is enabled or

left in the not configured state.

Prevent displaying advanced indexing options in the Control Panel


advanced options dialog; otherwise, it can be opened. Disabled by default.

Additional Information and Resources

WDS Supplemental License TermsMicrosoft Corporation (or based on where you live, one of its affiliates) licenses this supplement to

you. You may use a copy of this supplement with each validly licensed copy of Microsoft Windows

software identified for use with it (the 'software'). You may not use it if you do not have a license for

the software. The license terms for the software apply to your use of this supplement.

Top of page

SupportFull service break or fix support is available through the customary Microsoft support channels.

Support is offered on a pay-per-incident basis or through contract programs such as Premier and

Essential. For more information about support options, visit the following Microsoft Web site:


40

http://www.microsoft.com/services/microsoftservices/srv_support.mspx

Or, call toll-free at 1-800-936-3500 in the U.S. and Canada only. For information about international

support options, visit the following Microsoft Web site:

http://support.microsoft.com/common/international.aspx

Top of page

Troubleshooting WDSBelow is a list of current known issues with WDS 3.01 and differences from WDS 2.66 that might

cause support issues.

WDS 3.01 Troubleshooting Tips

Categories Searching, AQSSymptom(s) When I search for specific file types using the Advanced Query Syntax (AQS) keyword

fileext, nothing is found. Example: fileext:doc

Diagnostics n/aSolution Use the keyword ext instead.

Example: ext:docCategories Searching, AQSSymptom(s) When I search for video files using the AQS keyword subject, nothing is found.

Example: subject:myvideoDiagnostics n/aSolution Use the name keyword instead.

Example: name:myvideoCategories Searching, AQSSymptom(s) When I search for music using the AQS keyword lyrics, nothing is found.Diagnostics n/aSolution None.Categories SearchingSymptom When I search for specific file types using the Documents filter, nothing is found. Diagnostics On Vista x64, Office 12 file types (for example, docx and pptx) are not registered as

Kind=Documents, and therefore are not being filtered correctly.Solution Manually register the files types under the following registry key:

HKLM\Software\Microsoft\Windows\CurrentVersion\Explorer\KindMapName Type Data.docx REG_SZ document.dotx REG_SZ document.pptx REG_SZ document.xlsx REG_SZ document

Categories SearchingSymptom(s) When I search on a full file name, nothing is found.

Example: myfile.docDiagnostics n/aSolution Surround the file name in quotation marks.

Example: “myfile.doc”Categories SearchingSymptom(s) When I search for files on Windows Vista, I cannot find the files that I expect to find, even

though the files exist on the computer.Diagnostics This issue may occur in any of the following scenarios.

• The file is not in the location that you are currently searching • The file is located in a system folder• The file is a hidden file• The file contains the search term in one of its properties and not in the file name


http://support.microsoft.com/common/international.aspx

http://www.microsoft.com/services/microsoftservices/srv_support.mspx

41


• The file type of the file is not indexed• The file has properties that prevent it from being indexed• The indexer has not yet indexed the file• The indexer is overlooking the file

Solution If the file is not in the location you are currently searching:1. Under Did you find what you were looking for? at the bottom of the search

results window, click Advanced Search.2. Select Everywhere from the Location list.3. Select the Include non-indexed, hidden, and system files check box.

If the file is in a system folder (Program Files or Windows folders):1. Start your search directly in the system folder in Explorer.

Or:1. In Explorer, click Organize and select Folder and Search Options.2. On the Search tab, select the Include system directories checkbox.3. Give the indexer time to index the new folders and start your search again.

Or:1. Under Did you find what you were looking for? at the bottom of the search

results window, click Advanced Search.2. Select Everywhere from the Location list.3. Select the Include non-indexed, hidden, and system files check box.

If the file is a hidden file:1. Under Did you find what you were looking for? at the bottom of the search

results window, click Advanced Search.2. Select Everywhere from the Location list.3. Select the Include non-indexed, hidden, and system files check box.Or,1. In Explorer, click Organize and select Folder and Search Options.2. On the View tab, select the Show hidden files and folders checkbox.3. Give the indexer time to index the new folders and start your search again.

If the file contains the search term in a property rather than the file name:1. In Explorer, click Organize and select Folder and Search Options.2. On the Search tab, select the Always search filenames and contents

checkbox.If the file is not in an indexed location:

1. From Control Panel, open Indexing Options.2. Click the Modify button.3. Click the Show all locations button.4. Select the check boxes of all locations you want included in the index.

If the file type of the file is not indexed:1. From Control Panel, open Indexing Options.2. Click the Advanced button.3. On the File Types tab, verify whether the file type you want is listed and selected.4. If it is listed but not selected, select the file extension’s check box5. If it is not listed, enter the file extension in the text box at the bottom of the dialog

and click the Add new extension button.If the file has properties that prevent it from being indexed:

1. Change the file’s properties to allow indexing.a. Right-click the file and select Properties.b. Clear the Hidden check box, or click Advanced and select the Index this

file for faster searching check box.Or, 1. Under Did you find what you were looking for? at the bottom of the search

results window, click Advanced Search.2. Select the Include non-indexed, hidden, and system files check box.Or,


42


1. In Explorer, click Organize and select Folder and Search Options.2. On the Search tab, select Don’t use the Index when searching the file

system.If the indexer has not yet indexed the file:

1. From Control Panel, open Indexing Options.2. Verify whether indexing is complete.

WDS indexes files when there is low user activity, so if you add lots of new files or locations, the indexer may need time to catch up.

If the indexer is overlooking the file, rebuild the index:1. From Control Panel, open Indexing Options.2. Click the Advanced button.3. Click the Rebuild button and then OK.

Rebuilding the index may take some time to complete.Categories Installation, upgradeSymptom(s) None of my old locations are indexed after upgrading to 3.01 from 2.x or 3.0. Upgrading

wipes out my entire crawl scope.Diagnostics n/aSolution Re-add the locations you want indexed:

1. From Control Panel, open Indexing Options.2. Click the Modify button.3. Click the Show all locations button.4. Select the checkboxes of all the locations and folders you want indexed.

Categories EFS supportSymptom(s) I cannot index items that are EFS encrypted.Diagnostics n/aSolution WDS 3.01 does not support EFS encryption. If you require this, you will need to use WDS

2.66. Categories Indexing locationsSymptom(s) Some locations are listed twice in my Indexing Options dialog.Diagnostics Installing the “Add-in for Files on Microsoft Networks” causes FAT32 drives to appear twice

in the Indexing options dialog.Solution None. Categories Indexing locationsSymptom(s) I cannot index hardlinks.Diagnostics n/aSolution None. Windows Search does not support traversing hardlinks and indexing their content.Categories Indexing locationsSymptom(s) I deselect the My Documents folder in the Indexing Options dialog, but when I reboot, it gets

selected again.Diagnostics XP onlySolution 1. Under HKLM/Microsoft/Windows Search, create a new registry key,

FolderRedirection. 2. In this key, create a new DWORD value, HandleRedirection, and set the DWORD to 0.

This will allow you to deselect your documents.

Categories Indexing locationsSymptom(s) How can I search UNC shares on a server from the Vista Start menu?DiagnosticsSolution You cannot search UNC shares from the Start menu unless you have taken the share offline.

You should not do this for large shares that are bigger than your hard drive.However, you can search UNC shares by navigating to the share in Windows Explorer and typing in the word wheel. This will be slower than normal search.

Categories Indexing locationsSymptom(s) I cannot search Sharepoint document libraries in Vista.Diagnostics n/aSolutions Sharepoint document libraries can be translated to a UNC share path and searched that

way.For instance http://Company/Team/Contoso/Project translates to \\company\team\Contoso\ProjectIn Vista, you can navigate to this UNC path in Windows Explorer and search using the word


http://Company/Team/Contoso/Project

43


wheel. It will be slower than searching against indexed locations. To make this easier you can also map a network drive to the location.

Categories Indexing locationsSymptom(s) I cannot add a UNC file path on a 64-bit Microsoft Windows operating system.Diagnostics n/aSolutions There is no workaround for this. The UNC protocol handler doesn’t currently support 64-bit

versions of Windows.Categories ErrorsSymptom(s) I get error 0x80070002 (File Not Found).Diagnostics Registry entries for Crawl Scope Manager are corrupt.Solution You must reinitialize the scope rules and restart the service:

1. From an elevated Command Prompt window, type net stop wsearch and press the ENTER key.

2. In the Registry Editor, navigate to:HKey_Local_Machine\Software\Microsoft\Windows Search\SetupCompletedSuccessfully

3. Change the REG_DWORD value to 0.4. In the Command Prompt window, type net start wsearch and press the ENTER key.

Categories ErrorsSymptom(s) I receive a warning message that the protocol handler Search.Mapi2Handler.1 cannot be

loaded.DiagnosticsSolution This is a known issue on 64-bit Windows XP and Windows 2003 operating systems because

there currently is no 64-bit Outlook MAPI provider. The warning message is a notification only and has no impact on indexing or searching.

Categories Errors, failuresSymptom(s) Indexing fails with Event 3100 in event log (SearchFilterHost.exe fails to start).Diagnostics n/aSolution 1. From the Start menu, open Control Panel.

2. Open Administrative Tools.3. Double click Services.4. Double click Windows Search from the list of services.5. On the Log On tab, clear the Allow service to interact with desktop check box.

Categories Back-off, power usageSymptom(s) The indexer is permanently backed off due to “Low Battery” even on desktops and on

laptops that are plugged in.Diagnostics n/aSolution Reset your power profile is set to High Performance:

1. From Control Panel, open Power Options.2. Select High Performance.Some laptops may automatically change the setting to Power Saver mode whenever the battery is low and may not change the setting back when plugged in.

Categories PerformanceSymptom(s) Large XML files take a long time to index and/or consume up to 100% CPU. Diagnostics n/aSolution This happens when the large XML file is frequently changing. You can prevent the specific

file from being indexed:1. In Windows Explorer, right click the file.2. Select Properties.3. Click the Advanced button4. Clear the Index this file for faster searching option, and click OK.

Categories Missing documentationSymptom(s) I cannot find the Help About information for WDS.Diagnostics n/aSolution From Control Panel, open Add/Remove Programs.

Locate Windows Desktop Search 3.01 and click Click here for support information.Categories Customization, shortcut keysSymptom(s) I can’t find the option to add a shortcut key (or keyboard shortcut) to access the Deskbar on

WDS 3.0.


44


Diagnostics n/aSolution Manually add the hotkey combination in the registry using the HotKey and

UseWinKey settings:Name Default Value DescriptionUseWinKey 1 Enables and disables the Windows key in the

keyboard short cut. 1=enabledHotKey 146 The high order bits identify the extended keys

(shift, ctrl, alt) and the low order bits identify the ASCII character in the keyboard short cut. The default is 146, where 1=shift and 46=F.

The high order bits identify these extended keys: 0: None1: Shift2: Ctrl4: Alt

To combine multiple keys, add the hex numbers. For example, to use Ctrl+Shift+F, the HotKey value is 346 and the UseWinKey value is 0.

Categories Search resultsSymptom(s) Items listed in the search results view don’t appear correctly:

Icons do not appear Context menus don’t appear when I right-click items Items don’t open when I click or double-click on them.

Diagnostics Some 3rd party integrations with Windows Desktop Search are not complete and therefore don’t have a full set of features.

Solution None.Categories EmailSymptom(s) I get an error when trying to index an Outlook Express messages.Diagnostics Error message: Outlook Express could not be started. The application was unable to open

the Outlook Express message store. Your computer may be out of memory or your disk is full. Contact Microsoft support for further assistance. (0x80004005, 183)

Solution Outlook Express fails when the Hotmail synchronization for a folder is set to download headers only. To fix this, change the synchronization to download messages:1. In Outlook Express, right-click your inbox and select Synchronization Settings.2. Select either Download Messages or Don’t Synchronize.

Categories EmailSymptom(s) Outlook stops indexing mail after the domain alias is changed (for example, the user name

is changed or is moved to another domain).Diagnostics n/aSolution 1. From Control Panel, select Indexing Options.

2. Click Modify.3. Clear the checkbox next to your Outlook entry and click OK.4. Click Modify again.5. Reselect your Outlook entry and click OK.This updates the system with your new alias.

Categories Email, ErrorsSymptom(s) I installed Outlook 2007 and Business Contacts Manager and I now get this error message:

“Microsoft Windows Search Protocol Host has encountered a problem and needs to close.”Diagnostics n/aSolution Install the KB923319 fix from your Outlook or Business Contacts Manager installation CDs.Categories Email, indexing locationSymptom(s) Outlook appears twice in the Indexing Options dialog but I only have one profile or mailbox.Diagnostics If you have online folders manually stored locally in an OST and can switch between

working online and offline, you are in “Classic OST” mode. If you normally work online but have at one time ever clicked "Work Offline", then you are also probably in this mode. In the Indexing Options dialog, one store represents the online data and one the offline data.

Solution None.We recommend not using Classic Offline mode for Outlook. Either use online mode, or switch to cached mode which is very similar to using online mode in conjunction with


45


Classic Offline mode.Categories EmailSymptom(s) Outlook Express items aren’t indexed on 64-bit machines.Diagnostics n/aSolution None.Categories EmailSymptom(s) For environments that do not use multiple Windows accounts for multi-user machines,

password protection of personal folders will not prevent discovery of information from other users’ Personal Folders files (.pst files).

Diagnostics Once Outlook loads a .pst, Windows Desktop Search has no way of knowing the file is password protected as this is managed by Outlook.

Solution To secure user profiles, you must use single-user accounts on Windows. Profiles in Outlook have no relation to hardware and software profiles in the Microsoft Windows operating systems. So although you can assign a password to individual folders within a Personal Folders file (.pst), you cannot protect Outlook profiles by using a password. To help protect your Outlook data, use a password-protected Windows user account. For more information, see Using Outlook on a computer you share with other people.

Categories EmailSymptom(s) Outlook is not indexing my emails.Diagnostics Verify whether mssphtb is not listed as one of the items at the registry location(s):

HKEY_CURRENT_USER\Software\Microsoft\Office\11.0\Outlook\Resiliency\DisabledItems

OrHKEY_CURRENT_USER\Software\Microsoft\Office\

12.0\Outlook\Resiliency\DisabledItemsSolution Remove mssphtb from these registry entries.Categories Group PolicySymptom(s) I want to prohibit indexing certain file types, but those file types are still selectable in the

Indexing Options dialog.Diagnostics n/aSolution This is a known issue. While prohibited file types are selectable in the dialog, the indexer

does NOT index them. Categories Group PolicySymptom(s) I can’t prevent the indexing of Outlook Express.Diagnostics If you look in the Indexing Options Control Panel and Outlook Express is a selectable option,

then the Group Policy is not correctly applied.Solution Add the following path to the “Prevent Indexing Certain Paths” policy:

outlookexpress://{*}Categories Group PolicySymptom(s) I want to enable\disable the indexing of mapped network drives.Diagnostics Open the Indexing Options Control Panel. If the mapped drive is automatically selected

(and you are trying to enable indexing) or grayed out (and you are trying to disable indexing), the appropriate policy has been selected.

Solution The correct syntax for inputting a mapped network drive is the following:otfs://{*}/<drive letter>/*

An example using the P drive is the following:otfs://{*}/p/*

Categories Add-insSymptom(s) With the Lotus Notes Add-in installed, I occasionally won’t be able to launch Lotus Notes.DiagnosticsSolution Go into Task Manager and make sure all Lotus Notes processes are closed. Then, re-launch

Lotus Notes. Categories Add-insSymptom(s) With the Lotus Notes Add-in installed, I can’t single click on Lotus Notes items in the

deskbar and have them open.DiagnosticsSolution This is being fixed in the next release.

To workaround the issue, you can either: Right-click the item in the deskbar, and select Open or


http://office.microsoft.com/search/redir.aspx?AssetID=HA011110031033&CTT=5&Origin=HA011471581033



46


Use the main WDS UI to search for the item and double-click it to open.

You can also obtain information by visiting the Windows Desktop Search Forum. For more

information visit the following Microsoft Web site:

http://forums.microsoft.com/MSDN/ShowForum.aspx?ForumID=127&SiteID=1

If your issue has not been discussed in the forum, you can post your questions, issues, or concerns.

This site is monitored by Microsoft. Although the forum is largely user-driven, Microsoft employees

often review and post responses to questions or comments in the forum.

Note The Windows Desktop Search Forum is a peer-to-peer communication vehicle aimed at

enhancing user experience, knowledge, and development-related efforts. Whenever possible,

Microsoft employees participate in the forum by answering questions and sharing Windows Desktop

Search-specific information. However, note that posting a question or comment in the Windows

Desktop Search Forum does not guarantee a reply by a Microsoft employee or Microsoft

representative. Microsoft does not guarantee as correct any post made within this forum by its

employees, representatives, or forum users, and confers no rights to these replies.

Top of page

Additional Links

License terms for software licensed from Microsoft

System Requirements

WDS Developer Forum on MSDN

MSN Search Toolbar (corporate Website)

The package installer (Formerly Update.exe)

Information about Group Policy on Microsoft TechNet

WDS Group Policy template file

WDS developers guide

WDS Add-ins

MSN Search Toolbar Syntax

FAQ for Windows Desktop Search

Additional WDS Troubleshooting Information

Document revision history

Date Changes made

Sept

26,

2007

Updated with Troubleshooting tips.

Feb 30, Updated information relating to the following:


http://www.microsoft.com/technet/prodtechnol/windows/search/dtstshoot.mspx

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideFAQ

http://search.msn.com/docs/toolbar.aspx?t=MSNTbar_PROC_CompleteSearchSyntax.htm

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideAddins

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideWDSDev

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideADMDownload

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideTechnetGP




http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideSysReq

http://g.microsoft.com/8WSENUS030000WDS/WDSAdminGuideWindowsLicense


47

Date Changes made

2007 Update to entire document as it relates to the new architecture of Windows Search

now being a service (WDS 3.x).

New documentation on Group Policy and limitations

Nov

11,

2006

Updated information relating to the following:

Update to policies with behavior modifications including preventing indexing of an

Uncached exchange folder and index location changes

New policies for bandwidth throttling of the indexer and hiding the Web search

button

Inclusion of availability of the Enterprise components pack

General organization and update to sections including:

o Pre-installation considerations section

Impact to Exchange

Network performance and bandwidth throttling

Roaming User Profiles

Terminal server

o Installing WDS

Upgrading WDS

Installer command line options

Wrapping WDS into an MSI wrapper

o Group Policy section

Indexing of email and my documents policy

Prevent indexing of Outlook policy

o Additional information and Resources section

May

26,

2006

Updated Information relating to the following:

Add-ins

Roaming Profiles

How WDS works with Exchange Server

New policies and how to install the ADM file

International versions and the MUI pack

Enterprise Deployment Checklist

Security and privacy

Added link to the MSDN Developers Forum

Added Last Updated field to top of document

Mar 8, 2006

New revision. Added additional sections and this revision table.

Jan 26,

2006

Updated WDS installation package to WindowsDesktopSearch-KB907371-V2-x86-

XXX.exe where XXX is the localization code for the language of the package. I.E. ENU.

Added release date version table.

Top of page


windows desktop search administration guide 3 revb

Documents

keyboard short

launch lotus

knowledge

search results

custom action

desktop search

small icon

sharepoint