About the Installation and Configuration Process

Software Requirements

Overview of Installation and Configuration Tasks

Supported Deployment Configurations

Installable Components

Installing UDDI Services 3.0

Configuring Windows Firewall

Installing UDDI Services in Interactive Mode

Configuring UDDI Services 3.0

Basic Configuration

Custom Configuration

Installing and Configuring UDDI Services in Silent Mode

Verifying UDDI Services 3.0

Uninstalling UDDI Services 3.0

Known Issues

Copyright

This document provides detailed instructions for installing and configuring UDDI Services 3.0 included with Microsoft® BizTalk® Server 2010.

This document is updated when new information regarding installing UDDI Services 3.0 becomes available. You can download the latest version of this document at http://go.microsoft.com/fwlink/?LinkID=198130.

For information about installing and configuring BizTalk Server 2010 see the installation guides at http://go.microsoft.com/fwlink/?LinkID=189046.

About the Installation and Configuration Process

This section provides an overview of the UDDI Services 3.0 installation and configuration process.

Software Requirements

This version requires the following software prerequisites prior to installing:

  • Windows Server 2008 R2 or Windows Server 2008 SP2 x86 and\or 64-bit editions.

  • Internet Information Services (IIS). IIS 7.0 or IIS 7.5 is required for hosting the UDDI Web Application.

  • .NET Framework 4 or .NET Framework 3.5.

  • SQL Server 2008 R2 or SQL Server 2008 SP1. SQL Server Compact edition is not supported. SQL Server Express edition is supported only in a standalone installation. Windows Internal Database (WID) is not supported for this release of UDDI Services.

Overview of Installation and Configuration Tasks

The following table provides an overview of the tasks needed to install and configure UDDI Services 3.0 on a new computer with no operating system installed.

Task Notes

Task 1: : Install Windows Server 2008 R2 or Windows Server 2008 SP2

After installing Windows, you must be logged on as an administrator to complete the full installation process of UDDI Services.

Task 2: Install critical updates for Windows

Install any high priority updates listed at the Windows Update Web site.

Task 3: Install Internet Information Services

When installing IIS on Windows Server 2008 R2 or Windows Server 2008 SP2, you must enable following IIS features:

  • ASP.NET

  • Basic Authentication

  • Windows Authentication

  • IIS 7.0/IIS 7.5 Metabase Compatibility

Task 4: Install SQL Server 2008 R2 or SQL Server 2008 SP1

When installing SQL Server:

  • Install using default settings

  • A local SQL Server instance is required for installing UDDI Services Database Component

Task 5: Install UDDI Services components

Default components are installed automatically. You can also choose optional components such as Notification Service.

Task 6: Configure UDDI Services components using UDDI Services Configuration Wizard

UDDI Services configuration wizard can be run in basic or custom mode.

Supported Deployment Configurations

A basic installation requires an instance of the UDDI Services Database and one or multiple instances of the UDDI Services Web Application. If you choose to enable the optional notifications feature, an instance of Notification Service is also required. You can deploy UDDI Services as either a stand-alone installation or a distributed installation.

Stand Alone Installation

In a stand-alone installation, all default and optional components are installed on a single server. An instance of SQL Server must be installed before installing UDDI Services. When installing UDDI Services, the local instance of SQL Server is used to host the UDDI Services Database. UDDI Services Web Application and Notification Service are then configured to use the local UDDI Services Database.

Distributed Installation

If you require high-availability for UDDI Services, use a distributed installation. In a distributed installation, you install the UDDI Services Database, one or more instances of the UDDI Services Web Application, and the optional Notification Service on different servers. You can set up UDDI Service Database on a clustered SQL Server. You must install and configure the UDDI Services Database component on both the active node and the passive node of the cluster, though the actual UDDI database is only created during the configuration on the active node. The recommended sequence is that you install and configure the UDDI Services Database component on the passive node first and then on the active node.

You can also set up a web farm that consists of multiple UDDI Services Web servers. You must install and configure the UDDI Services Web Application on each Web server box that is configured in the farm.

Note

For a distributed installation, Windows Firewall must be configured to allow Remote Access. For distributed installation on Windows Server 2008 R2 or Windows Server 2008 SP2, Windows Firewall must also be configured to enable Remote Administration.

Top of page

Installable Components

This version of UDDI Services includes the following primary components:

Database component: This component provides data storage services for a site using an instance of SQL Server. In addition to storing site data, the UDDI Services Database also stores all site-wide configuration settings, such as the name of a site, user group mappings, and all security settings for the site.

Web Application: This component uses Internet Information Services. The Web user interface provides search, publishing, subscription, and coordination capabilities. This component provides support for the UDDI APIs and Windows Integrated Authentication, UDDI publisher authentication, or a combination of the two on both the Web UI and API interfaces.

Notification Service: This Windows service component can send subscriber’s notifications of data changes in services registered in UDDI Services.

Administration Tools: This component includes the following administration tools:

  • UDDI Services Management Console: This MMC snap-in can be used to change the configuration settings of UDDI Services to customize runtime policies. For example, you can configure user groups for different roles or change the authentication method. You can launch UDDI Services Management console by clicking Start, point to All Programs, point to Microsoft UDDI Services, and then click UDDI Services Management Console.

  • Data Export Tool: A wizard that you can use to select providers or tModels that are hosted in a UDDI Services site and export their details to an XML file. You can run this tool by clicking Start, point to All Programs, point to Microsoft UDDI Services, point to UDDI Tools, and then click Data Export Tool.

  • Categorization Scheme Editor: A UI tool for creating and modifying categorization schemes that comply with UDDI Services. You can run this tool by clicking Start, point to All Programs, point to Microsoft UDDI Services, point to UDDI Tools, and then click Categorization Scheme Editor.

  • uddiconfig.exe: A command-line tool that applies configuration settings from an XML document to UDDI Services components or retrieves configuration settings from UDDI Services components and stores them in an XML document. This tool provides a command line interface to the same functionality that the UDDI Service MMC snap-in provides. This tool is located under the bin/ folder in the UDDI Services installation folder.

  • Backup.exe: A command-line tool that backs up or restores the UDDI Services Database. This tool is located under the bin/ folder in the UDDI Services installation folder.

  • Bootstrap.exe: A command-line tool that loads XML data such as exported UDDI data entities and categorization schemes into the UDDI Services Database. This tool is located under the bin/ folder in the UDDI Services installation folder.

  • Uddimigrate.exe: A command-line tool that enables data migration from a UDDI Service v2.0 site to a UDDI Service v3.0 site. This tool is located under the bin/ folder in the UDDI Services installation folder.

Developer Tools and SDK: The developer tools include the Publish Wizard tool, Digital signing tool, and UDDI Services software development kit.

Top of page

Installing UDDI Services 3.0

Configuring Windows Firewall

For a distributed installation of UDDI Services, you must configure Windows Firewall on each server to allow remote access. How to enable Windows Firewall will depend on the operating system and SQL Server.

To configure Windows Firewall for remote access on a SQL Server computer, see Configuring the Windows Firewall to Allow SQL Server Access at http://msdn.microsoft.com/en-us/library/cc646023.aspx.

When installing UDDI Services on Windows Server 2008 R2 or Windows Server 2008 SP2, you must enable Remote Administration.

To enable Remote Administration in Windows Firewall in Windows Server 2008 R2 or Windows Server 2008 SP2
  1. In Control Panel, click System and Security and then click Windows Firewall.

  2. Click Allow a program or feature through Windows Firewall, and then click the Change Settings.

  3. In the Allowed programs and features list, select the check box for Remote Administration.

Installing UDDI Services in Interactive Mode

This section explains how to use the interactive setup to install and specify options and properties of UDDI Services on your computer.

Before you begin installation, ensure that your computer complies with the requirements listed in Software Prerequisites.

Important

Close all applications before running setup.

Note

There is no discernable difference in user instructions when running setup on x86 and\or 64-bit editions.

To install UDDI Services in Interactive Mode
  1. Insert the Microsoft BizTalk Server 2010 installation disk into the CD-ROM drive. If the BizTalk Server Setup page does not appear, double-click setup.exe located in the root of the installation CD.

  2. On the BizTalk Server 2010 Installation Wizard page, click Install Microsoft UDDI Services on this computer.

  3. On the Component Installation page, in Available Components, select and click from the available components you want to install.

  4. In Install To: specify a location to install UDDI Services components, and then click Next.

  5. On the Summary page, review installation details and then click Install.

Top of page

Configuring UDDI Services 3.0

After installing UDDI Services, you must use the Microsoft UDDI Services Configuration wizard to configure and enable components. The configuration wizard supports two modes: Basic or Custom. You can run Microsoft UDDI Services Configuration wizard in Basic mode immediately after running setup by selecting the Launch Configuration Wizard check box on the Installation Completed screen of the Installation Wizard. You can also run the Configuration Wizard at any time after installing UDDI Services by clicking Start, point to All Programs, point to Microsoft UDDI Services, and then click UDDI Services Configuration.

Note

You can only run Custom configuration if you have already run either Basic or Custom configuration after installing UDDI Services.

Important

Secure Sockets Layer (SSL) encryption is automatically selected during Basic configuration of the UDDI Services Database Component. If you do not want to use SSL encryption, you can use Custom configuration to de-select the Require SSL for publication to this UDDI Services site option on the Configure UDDI Services Database Component page. When using SSL encryption with UDDI Services, you must configure a server certificate for the Internet Information Services (IIS) service that hosts the UDDI Services Web Application and then create an HTTPS binding for the web site. For more information about configuring server certificates on a Web server, see Configuring Server Certificates in IIS 7.0 at http://go.microsoft.com/fwlink/?LinkID=64327.

Basic Configuration

Basic configuration is targeted for first-time users. Use this option to configure the server with default settings.

To configure UDDI Services using Basic Configuration
  1. In Database server name, type the name of the server that hosts the UDDI database.

  2. In User name, type the user name for the account that the services will run under. When using Basic configuration, all services will run under this account.

  3. Click Configure.

  4. On the Summary screen, review configuration information, and then click Next.

Custom Configuration

Custom configuration allows you to configure the server using advanced configuration options. With custom configuration, you can enable and disable features and customize settings.

Help for Custom configuration is provided in the online Help installed with UDDI Services. You can view information and procedures on how to use Custom configuration by clicking Help on the Microsoft UDDI Services Configuration tool menu.

You can run the Configuration Wizard in Custom configuration mode at any time after installing UDDI Services by clicking Start, point to All Programs, point to Microsoft UDDI Services, and then click UDDI Services Configuration.

Top of page

Installing and Configuring UDDI Services in Silent Mode

This section explains how to use the silent mode to install and setup different installer options and properties of UDDI on your computer. Using silent mode requires a custom XML configuration file.

Before you begin installation, ensure that your computer complies with all hardware, software, and security requirements.

Important

Close all applications before you begin installation.

To install UDDI Services in Silent Mode
  1. Click Start, point to All Programs, point to Accessories, and then click Command Prompt.

  2. To start the silent installation, at the command prompt, type Setup.exe /s <xml config file> /product uddi, and then press Enter.

To configure UDDI Services in Silent Mode
  1. Click Start, point to All Programs, point to Accessories, and then click Command Prompt.

  2. To start the silent installation, at the command prompt, type Configuration.exe /s <xml config file>, and then press Enter.

Note

You can export a custom configuration as an xml file. You can then use the custom configuration for identical silent installation and configuration on additional computers To create your custom xml config file, perform a manual configuration using the UDDI Services Configuration wizard, verify the components are functioning as required, and then export the configuration to an XML file by clicking File menu in the configuration wizard, and then clicking Export Configuration.

Sample UDDI Services xml config file:

<Configuration>
  <Feature Name="UDDIDatabaseComponent" DisplayName="UDDI Database Component" Version="1.0" Description="Description" ConfigByDefault="true" ISDIRTY="true">
    <Name ID="UDDI_DB_DataLocation" DisplayName="Database Data Files L&amp;ocation:" Description="for description" Hidden="false">
      <Value>C:\Program Files (x86)\Microsoft UDDI Services\data\</Value>
    </Name>
    <Name ID="UDDI_DB_LogLocation" DisplayName="Database &amp;Log Files Location:" Description="for description" Hidden="false">
      <Value>C:\Program Files (x86)\Microsoft UDDI Services\data\</Value>
    </Name>
    <Name ID="UDDI_DB_SiteName" DisplayName="&amp;Site Name:" Description="for description" Hidden="false">
      <Value>UDDI</Value>
    </Name>
    <Question ID="UDDI_DB_SSL" Text="Require the use of SSL for the &amp;publication to this UDDI Services site" Answers="yes,no" Default="yes">
      <Answer Value="yes" GUID="{045B7725-AB68-41b6-81F1-8A1DB01FE4F3}" />
      <Answer Value="no" GUID="{560AB833-C57C-4461-B62A-33156E767233}" Selected="Yes" />
    </Question>
    <DatabaseInstance ID="UDDI_DB_Instance" DisplayName="S&amp;QL Server Instance" Description="for description">
      <DatabaseInstanceName>(Default)</DatabaseInstanceName>
    </DatabaseInstance>
  </Feature>
  <Feature Name="UDDIWebApplication" DisplayName="UDDI Web Application" Version="1.0" Description="Description" ISDIRTY="true" ConfigByDefault="true">
    <SQL ID="UDDI_Web_Database" DisplayName="UDDI Database" Description="for description">
      <Server>UDDITEST2K3X64</Server>
      <Database>UDDI3</Database>
      <WindowsSecurity>yes</WindowsSecurity>
      <UserName />
      <Password />
    </SQL>
    <NTService ID="UDDI_Web_ServiceAccount" DisplayName="UDDI Application Pool Account" Description="for description">
      <UserName>NETWORK SERVICE</UserName>
      <Domain>NT AUTHORITY</Domain>
      <Password>
      </Password>
    </NTService>
    <Question ID="UDDI_Web_SelfRegister" Text="Self-register services and bindings in A&amp;ctive Directory Domain Services (AD DS)" Answers="yes,no" Default="yes">
      <Answer Value="yes" GUID="{A2C86C85-7C59-4c0c-A874-7275297940E8}" Selected="Yes" />
      <Answer Value="no" GUID="{A8C07E97-659B-4f0b-A68D-DB42C1337B55}" />
    </Question>
    <WebSite ID="UDDI_Web_WebSite" DisplayName="UDDI Services Web Si&amp;te" Description="for description">
      <WebSiteName>Default Web Site</WebSiteName>
    </WebSite>
  </Feature>
  <Feature Name="UDDINotificationService" DisplayName="UDDI Notification Service" Version="1.0" Description="Description" ConfigByDefault="true" ISDIRTY="true">
    <SQL ID="UDDI_Notification_Database" DisplayName="UDDI Database" Description="for description">
      <Server>UDDITEST2K3X64</Server>
      <Database>UDDI3</Database>
      <WindowsSecurity>yes</WindowsSecurity>
      <UserName />
      <Password />
    </SQL>
    <NTService ID="UDDI_Notification_ServiceAccount" DisplayName="UDDI Notification Service Account" Description="for description">
      <UserName>NETWORK SERVICE</UserName>
      <Domain>NT AUTHORITY</Domain>
      <Password>
      </Password>
    </NTService>
    <Name ID="UDDI_Notification_SMTPServer" DisplayName="&amp;SMTP Server:" Description="for description" Hidden="false">
      <Value>smtphost</Value>
    </Name>
    <Name ID="UDDI_Notification_EmailAddress" DisplayName="E-mail add&amp;ress:" Description="for description" Hidden="false">
      <Value>lping@microsoft.com</Value>
    </Name>
    <Question ID="UDDI_Notification_SMTPAuthentication" Text="Anon&amp;ymous authentication;Windows au&amp;thentication using the windows service credentials;&amp;Basic authentication" Answers="0,1,2" Default="0">
      <Answer Value="0" GUID="{513F1301-F23F-43f9-872B-13D219577A3E}" Selected="Yes" />
      <Answer Value="1" GUID="{37F818D8-B771-4483-89C3-A36F3A1BE708}" />
      <Answer Value="2" GUID="{50EC986A-9694-4b82-B143-62271C2BD8B5}" />
    </Question>
    <Name ID="UDDI_Notification_UserName" DisplayName="User &amp;name:" Description="for description" Hidden="false">
      <Value />
    </Name>
    <Name ID="UDDI_Notification_Password" DisplayName="Passw&amp;ord:" Description="for description" Hidden="false">
      <Value />
    </Name>
    <Name ID="UDDI_Notification_ConfirmPassword" DisplayName="Confir&amp;m password:" Description="for description" Hidden="false">
      <Value />
    </Name>
  </Feature>
  <InstalledFeature>UDDIDatabaseComponent</InstalledFeature>
  <InstalledFeature>UDDIWebApplication</InstalledFeature>
  <InstalledFeature>UDDINotificationService</InstalledFeature>
  <InstalledFeature>UDDIAdministrationTools</InstalledFeature>
  <InstalledFeature>UDDIDeveloperToolsAndSDK</InstalledFeature>
</Configuration>

Top of page

Verifying UDDI Services 3.0

To verify UDDI Services 3.0 is installed correctly
  1. Log on to the server hosting the UDDI web application.

  2. Open Internet Explorer using "Run as Administrator".

  3. Type http://<local host name>/uddi, and then hit Enter. If UDDI Services is installed correctly, you will see the Welcome to Microsoft UDDI Services page.

Top of page

Uninstalling UDDI Services 3.0

To uninstall UDDI Services and all its components, follow these steps in the order shown.

Important

Do not remove prerequisites before you remove UDDI Services.

To uninstall UDDI Services
  1. Click Start, point to Control Panel, and then click Programs and Features.

  2. In the Programs and Features dialog box, click Microsoft UDDI Services, and then click Uninstall.

Note

Windows Installer runs a validation at the beginning of the uninstallation process. If any of the files to uninstall are open or are being used by another process, you will be asked to restart your computer after uninstalling UDDI Services 3.0.

To remove UDDI Services databases on SQL Server
  1. Click Start, point to All Programs, point to Microsoft SQL Server <version>, and then click SQL Server Management Studio.

  2. In Object Explorer, expand Databases.

  3. Remove the UDDI3 database.

    Note

    If you configured the server using Custom configuration and modified the database names, you will need to remove those databases.

Top of page

Known Issues

  • Installation of UDDI Services 2.0 over UDDI Services 3.0 is not supported

    Windows Server 2008 R2 or Windows Server 2008 SP2 allows you to install UDDI Services 2.0 over UDDI Services 3.0, but it corrupts the configured UDDI Services 3.0 in the computer. To get UDDI Services 3.0 fixed, you need to carry out the following procedure:

    1. Uninstall all the UDDI Services 2.0 using Server Manager in Windows Server 2008 R2/SP2.

    2. Launch Setup.exe in the UDDI Services 3.0 installation package, select Repair option and then follow the wizard to complete the Installation.

    3. In the Installation completion window, uncheck Launch UDDI Services Configuration Wizard and click Finish.

    4. In the command prompt, Run %ProgramFiles%\Microsoft UDDI Services\bin\backup.exe <SQL Server instance> command to back up the UDDI v3 database.

    5. Remove the UDDI3 database from the database server using Microsoft SQL Server Management Studio.

    6. Launch the configuration wizard tool and re-configure the installed components.

    7. In the command prompt, Run %ProgramFiles%\Microsoft UDDI Services\bin\backup.exe /restore <SQL Server instance> command to restore the UDDI v3 database.

  • UDDI web application cannot work alongside SharePoint Services if both are installed to the Default web site.

    Workaround: Configure SharePoint Services on a non-default website and UDDI Services on the default website.

Top of page

Copyright

Information in this document, including URL and other Internet Web site references, is subject to change without notice. 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. 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.

© 2010 Microsoft Corporation. All rights reserved.

Microsoft, Active Directory, BizTalk, IntelliSense, JScript, MSDN, Visual Basic, Visual C#, Visual C++, Visual Studio, Win32, Windows, Windows Server, Windows Server System, and Windows Vista are trademarks of the Microsoft group of companies.

All other trademarks are property of their respective owners.

Top of page