Service Registry Settings

Service information appears under the following registry subkey:

   HKEY_CURRENT_USER\Software\Microsoft\Office\11.0\Common\Research\Sources\{Provider}

For each service, a subkey appears under the appropriate Provider subkey. A provider can provide multiple services. The name of each service subkey is the globally unique identifier (GUID) that uniquely identifies the service. Each service subkey has the entries and values shown in the following table.

Note  The "Default value" column indicates the value used for this setting if the setting is missing or corrupt. The "Equivalent Registration parameter?" column indicates whether this registry setting has an equivalent XML parameter in the Microsoft.Search.Registration.Response namespace.

Entry nameValue typeValue dataRequired?Default valueEquivalent Registration parameter?
AboutPathStringURL that points to a description of the service.NoNoneYes
CategoryIDDWORDCategory under which the source is listed in the user interface. This is an index into the list of built-in categories. For possible values, see Service Categories.YesNoneYes
DescriptionStringShort description of the service.NoNoneYes
DisplayStringValues include:
  • On. The provider wants this service turned on in the user interface.
  • Off. The provider wants this service turned off in the user interface.
  • Hidden. The service does not show up in the Research task pane user interface. This means that only an internal process can use the service, as there is no external way to call it.
NoOffYes
OptionsPathStringURL that points to the user interface to change the service's settings.NoNoneYes
ParentalStringValues include:
  • Supported. The service supports parental control (that is, filtering of results to remove potentially offensive content).
  • Unsupported. The service does not support parental control.
NoUnsupported is assumed if absent or set to anything other than Supported.Yes
PersistDataDWORDInternal use only. This value should not be set by a custom research service.NoNoneNo
ServiceNameStringFriendly name of the service, for use in the user interface.YesNoneYes
SortOrderDWORDInteger indicating where the service ranks within its category. The lower the number, the higher the ranking. Sources are sorted first by Category (see Service Categories), then by SortOrder value, then alphabetically.No0No
SourceDataStringThis is an arbitrary BLOB (binary large object) of data, available for use by the developer of a custom service.NoNoneYes
StatusStringInternal use only. This entry should be set to "Enabled." Indicates that the service provider is enabled. Note: Office may temporarily change this value when performing update operations.YesNoneNo. This is set by Microsoft® Office 2003 automatically when adding a service through the Registration interface.
TermsOfUseStringCopyright string for the service.NoNoneYes
TermsOfUsePathStringURL that points to the terms of use.NoNoneYes

Caution  A translation service uses some of these settings in a distinctive manner. For more information, see Building a Translation Service.

Typical Registry Settings

The following screen shot displays typical service registry settings for the Factiva News Search research service, available from the Dow Jones and Reuters provider.

Typical service registry settings

Figure 1. Typical service registry settings.

©2003-2004 Microsoft Corporation. All rights reserved. Permission to copy, display and distribute this document is available at: http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp