Hello World Sample

  • Article

This Hello World sample research service accepts an arbitrary query and returns a query response that displays some simple text on the Research task pane.

Configuring the Hello World research service

This section assumes that the Research Service Software Development Kit has been installed on a client computer that is not necessarily the same computer as the computer that hosts the IIS server, ServerName.

Requirements

  • Microsoft® Office 2003
  • Microsoft .NET Framework 1.0 or later
  • Microsoft .NET Framework 1.0 Software Development Kit, or a later release
  • Microsoft Visual Studio® .NET 2003 (to modify and rebuild the Web service if necessary)
  • Microsoft Internet Information Services (IIS) 5.0 or later

Note  IIS should be installed before you set up the Microsoft .NET Framework SDK and Microsoft Visual Studio .NET. If you have installed or re-installed IIS after setting up the Microsoft .NET Framework SDK, you will experience unexpected behavior when you try to view ASP.NET pages. To fix this, register ASP.NET with IIS again by running the aspnet_regiis.exe utility. For more information, see Knowledge Base article 306005 , "HOWTO: Repair IIS Mapping After You Remove and Reinstall IIS."

Configure the research service

  1. Do one of the following:

    • If you have installed the Research SDK on the computer that hosts the IIS server ServerName, go to step 2.

    • If you have installed the Research SDK on a computer other than ServerName:

      1. Create a folder named Hello World Sample on ServerName.

        Note  To avoid access problems when running the Hello World Web service, do not place the Hello World Sample folder in the My Documents folder.

      2. From the computer that the SDK is installed on, copy the contents of the Hello World Sample folder (under Drive:\Program Files\Microsoft Office 2003 Developer Resources\Microsoft Office 2003 Research Service SDK) to the Hello World Sample folder on ServerName.

  2. On ServerName, create the bin folder under the Hello World Sample folder. Move HelloWorldVB.dll from the Hello World Sample folder to the Hello World Sample\bin folder.

  3. Map the Hello World Sample folder to a virtual directory named HelloWorldService on ServerName.

    1. From the Microsoft Windows® Start menu, click Control Panel, and then double-click Administrative Tools.
    2. Double-click Internet Information Services.
    3. In the Internet Information Services folder tree, expand the folders for the local computer, the Web Sites directory, and the Default Web Site.
    4. Create a new virtual directory named HelloWorldService by right-clicking Default Web Site and selecting New and Virtual Directory. Follow the instructions on the Virtual Directory Creation Wizard.

Using the Hello World research service

Before you can use the Hello World research service for the first time, you must add the research service to the Research task pane by using the URL http://ServerName/HelloWorldService/HelloWorldVB.asmx. For more information about adding a research service, see Adding Services through the Office User Interface.

The Hello World research service accepts any input. To use the service, select it as the research service to search.

Design of the Hello World research service

The Hello World research service specifies two Web methods: Registration and Query under the Search namespace. The page http://ServerName/HelloWorldService/HelloWorldVB.asmx provides a brief description of each of the methods, and a hyperlink to the formal definition of these methods.

Registration

This method is called the first time that you add the Hello World research service to the task pane and sends a registration request. This method puts together and returns a registration response. The registration response supports the Microsoft.Search.Registration.Response Schema.

Query

This method parses a query for the domain and query ID. It uses the same domain and query ID to fill out the query response packet, adds text to the content, fills out the rest of the packet, and returns it. The query response supports the Microsoft.Search.Response Schema.

For more information about the research service schemas, see XML Schemas Overview.