Installation Prerequisites

Required

Optional

What Is Installed?

Installing the BizTalk ESB Toolkit 2.1 Core

Installing the Exception Management Framework

Installing the JMS/WMQ Components

Installing the ESB Management Portal

Checking Portal Configuration Settings

Portal Configuration Settings

Installing the ESB Management Portal Alert Service

Installing the ESB Management Portal UDDI Publishing Service

Configuring Exception Management InfoPath Form Template Shares

Troubleshooting Portal Installation and Configuration

Security Considerations

General Multi-box Installation Steps

4-Box Installation

3-Box Installation

2-Box Installation

Copyright

This topic provides information for installing and configuring the ​Microsoft BizTalk ESB Toolkit . The ​Microsoft BizTalk ESB Toolkit spans a broad range of technologies, which rely on many existing applications, services, and operating system components.

When preparing your installation, it is useful to create and maintain a Virtual PC image that contains all the prerequisite software, including Microsoft SQL Server and Microsoft BizTalk Server. This approach can help solve most of the issues related to the numerous technologies involved and the permutation of security settings and other environmental factors. This process will also get you up and running quickly on development and production systems.

Installation Prerequisites

To achieve full functionality of ​Microsoft BizTalk ESB Toolkit solutions, you must install the following prerequisite applications and services. Follow this sequence to install the prerequisites and to configure your system.

Required

  • Windows Server 2008 SP2 and Windows Server 2008 R2

  • .NET Framework version 4 and .NET Framework 3.5

  • Internet Information Services (IIS) 7.0 with IIS 6.0 extensions

    Note

    You will need to select IIS 6.0 Management console and Windows Authentication when installing IIS 7.0.

  • SQL Server 2008 R2 or SQL Server 2008 SP1

  • BizTalk Server 2010 Enterprise Edition, including Business Activity Monitoring (BAM)

  • Visual Studio 2010

  • Microsoft Chart Controls for .NET Framework 4 and .NET Framework 3.5

Optional

  • Visual Studio 2010 Software Development Kit (SDK) (required by the Itinerary Designer in Visual Studio 2010)

  • Windows SDK for Windows Server 2010 and .NET Framework 4 and .NET Framework 3.5 (required by the ESB Management Portal)

  • Microsoft UDDI Services 3 (required by UDDI resolver and dependent samples)

  • BizTalk Server 2010 Business Activity Monitoring (BAM) Tools (required by Itinerary and Exception BAM tracking)

  • BizTalk Adapter Pack 2.1 (required for Message Enrichment Sample)

What Is Installed?

Please review the following sections to install the ​Microsoft BizTalk ESB Toolkit :

The ​Microsoft BizTalk ESB Toolkit installs the following components on the computer:

  • ESB Configuration Tool

  • Itinerary Designer

  • Microsoft BizTalk Server.msi files for ESB Core engine, exception handling, and Java Message Service (JMS)

  • ESB Toolkit samples

  • Utilities:

    • Microsoft.Practices.ESB.PersistConfigurationTool

    • Microsoft.Practices.ESB.RulesDeployer

Installing the BizTalk ESB Toolkit 2.1 Core

This section describes the process for installing the ​Microsoft BizTalk ESB Toolkit core components.

To install the Microsoft BizTalk ESB Toolkit 2.1 Core

  1. Install the ​Microsoft BizTalk ESB Toolkit .msi file appropriate for your platform. This step unpacks the files needed to install the ​Microsoft BizTalk ESB Toolkit and creates necessary registry entries. The Itinerary Designer can also be installed and registered with Visual Studio 2010. To do this, click the Tools option in the installer.

    • The ​Microsoft BizTalk ESB Toolkit .msi does not register the itinerary designer by default. Post installation, the user needs to select Install itinerary designer extensions under Start> All Programs> Microsoft BizTalk Server 2010 ESB toolkit.
    • Before uninstallation, the user needs to select Uninstall itinerary designer extensions under Start> All Programs> Microsoft BizTalk Server 2010 ESB toolkit.
  2. Import the appropriate ESB Toolkit Core .msi file as follows:

    • To import the core engine with bindings:

      1. Use the Microsoft.Practices.ESB.CORE.msi file and the BizTalk Server 2010 Administration Console. This step creates the Microsoft.Practices.ESB BizTalk Server application and register all required BizTalk Server artifacts in the BizTalk Server management database, such as built-in on-ramps, vocabularies, pipelines, and supporting assemblies.

      2. Install the Microsoft.Practices.ESB.CORE Windows Installer (.msi file) from the ​Microsoft BizTalk ESB Toolkit install folder. This step installs the supporting core and exception handling runtime assemblies to the global assembly cache and installs the pipeline components to the appropriate folder.

    • To import the core engine without bindings.

      1. Install the Microsoft.Practices.ESB.CORE_NOBINDING .msi file from the ​Microsoft BizTalk ESB Toolkit install folder. This step installs the supporting core and exception handling runtime assemblies to the global assembly cache and installs the pipeline components to the appropriate folder.

Note

The ESB.Deployment.Policy exists for deployment of the core ​Microsoft BizTalk ESB Toolkit vocabularies. This policy does not contain any business rules for the Microsoft.Practices.ESB application.

Next, configure the ​Microsoft BizTalk ESB Toolkit Core services and components.

To configure the BizTalk ESB Toolkit Core services and components

  1. Navigate to the installation path (the default path is C:\Program Files\​Microsoft BizTalk ESB Toolkit 2.1\) of the ​Microsoft BizTalk ESB Toolkit and launch the ESB Configuration Tool in the bin directory (ESBConfigurationTool.exe).

    Note

    For 64-bit versions of Windows, the default installation path will be %ProgramFiles(x86)%.

  2. Configure the Exception Management database. In the ESB Configuration Tool, select the check box. Provide the server and database name and credentials for your environment; the default database name is EsbExceptionDb. This step creates the exception handling database with the required permissions. Optionally, if choose to use an existing database to serve as the Exception Management database, you can make that selection here.

    Enabling the Exception Management database using the ESB Configuration Tool

    Note

    If you have already created the Exception Management database as part of a multi-server installation, select the Use Existing Database check box to connect to the existing database.

  3. After you finish configuring the Exception Management database, click Apply Configuration.

    Note

    When using the ESB Configuration Tool during initial installation, you must apply configuration changes to each section before you can continue to configure the next section. This process also validates each configuration section before you continue. Configuration of these sections must be completed consecutively.

  4. Configure the exception Web services. In the ESB Configuration Tool, select the Enable Exception Services check box to configure the exception Web services. Provide the user credentials for your environment; the user must be a member of the Administrators group or the BizTalk Isolated Host Users group. This step creates the two exception handling Web services that can be used by applications outside of the ​Microsoft BizTalk ESB Toolkit .

    Enabling the Exception Web Services using the ESB Configuration Tool

  5. Configure the Itinerary database. Using the ESB Configuration Tool, configure the itinerary database. This step creates the Itinerary database, which can be used as a repository for server-side itineraries.

    Note

    If you have already created ESB Toolkit Itinerary database as part of multi-server installation, select the Use Existing Database check box to connect to the existing database.

  6. Configure Core Web services. Using the ESB Configuration Tool, configure the core Web services. This step creates a range of Web services, including the core on-ramps and general functionality of the core, such as transformations, resolution, and Microsoft BizTalk Server operational information.

To enable the SSO Configuration Provider using the ESB Configuration Tool

Note

If you are installing and configuring the ESB Toolkit in a single server environment, you should use File Configuration Source. The SSO Configuration Provider is most commonly used for multiple machine deployments.

  1. Navigate to the installation path (the default path is C:\Program Files\​Microsoft BizTalk ESB Toolkit 2.1\) of the ​Microsoft BizTalk ESB Toolkit and launch the ESB Configuration Tool in the bin directory (ESBConfigurationTool.exe).

  2. Under ESB Configuration, click Configuration, and then select SSO Configuration Source.

  3. In the SSO configuration data section, type or enter the following information in each box:

    • In the Configuration file box, click the ellipsis button (…), and then browse to the Esb.config file, which is included in the ​Microsoft BizTalk ESB Toolkit .

    • In the Application Name box, type a name for the SSO application. For example, ESB Toolkit.

    • In the Contact Information box, type the appropriate contact information in the following format: someone@woodgrovebank.com.

    • In the the Administrator Group name box, click the ellipsis button, and then browse to the appropriate name.

    • In the User Group name box, click the ellipsis button, and then browse to the appropriate name.

  4. Click the Apply Configuration button to apply ​Microsoft BizTalk ESB Toolkit configuration changes. This step will create SSO applications for each configuration section defined in the Esb.config file in the SSO configuration database and update configuration source in the Machine.config file.

  5. Verify that user account associated with BizTalk server isolated host has valid permissions to access SSO configuration created for ​Microsoft BizTalk ESB Toolkit .

    Note

    When configuring ESB Toolkit on BizTalk cluster, the preceding steps are required when setting up the first server. Otherwise, manually update SSO Configuration provider settings for the rest of the BizTalk cluster.

    Enabling the SSO configuration provider using the ESB Configuration Tool

    Note

    If you have already created SSO configuration source as part of multi-server installation, manually replace ESB configuration section in the Machine.config file from the computer where the ESB Toolkit has already been configured.

To create ESB entries for Microsoft UDDI Services

  • Run the UDDI Publisher tool (you can install it at %ESB Install Folder%\Bin\Microsoft.Practices.ESB.UDDIPublisher.exe).

Note

Make sure that Microsoft UDDI Services does not require Secure Sockets Layer (SSL) for publication to the UDDI Services site.

Top of page

To install BAM definitions

  1. Install BAM itinerary tracking activity definition. BAM itinerary tracking can be used to track the progress and eventual completion of itineraries as they advance through various steps. The BAM definition file (Microsoft.BizTalk.ESB.BAM.Itinerary.xml) is located in the BAM folder in the installation directory and can be installed using the Bm.exe tool. Use the following command as an example.

    Bm.exe deploy-all -DefinitionFile:"C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Itinerary.xml"
    
    Note

    For multi-server deployment scenarios, you only need to install BAM definitions once.

  2. Install Exception Handling BAM tracking. The BAM definition file (Microsoft.BizTalk.ESB.BAM.Exceptions.xml) is located in the BAM folder in the installation directory and can be installed using the Bm.exe tool. Use the following command as an example.

    Bm.exe deploy-all -DefinitionFile:"C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml"
    

Top of page

To configure diagnostics and trace information

  1. To enable the ​Microsoft BizTalk ESB Toolkit trace switch, add the following <switches> element to the system.diagnostics section of the Machine.config file.

    <system.diagnostics>
          <switches>
              <add name="BizTalkESBToolkit20" value="4"/>
          </switches>
     </system.diagnostics>

Top of page

To install and run the sample applications

  1. Create a folder named Projects in the root of your C: drive, and create a subfolder named Microsoft.Practices.ESB within this folder.

    Note

    In the current release, the supported installation is for the files to reside in the folder C:\Projects\Microsoft.Practices.ESB. The BizTalk binding files that ship with the samples depend on this path.

  2. When you install the BizTalk ESB Toolkit, it includes a .zip file called ESBSource.zip in the installation location you specified (by default, C:\Program Files\​Microsoft BizTalk ESB Toolkit 2.1). Uncompress the ESBSource.zip file into the C:\Projects\Microsoft.Practices.ESB folder. This will create folders named Keys and Source that contain the sample key and the samples with source code. The Source folder contains the source code for the sample application, and the Keys folder contains the public keys used to sign the assemblies in the sample applications.

  3. Before you run the samples, remove the read-only attribute on the C:\Projects\Microsoft.Practices.ESB\ folder so that the samples install correctly.

  4. If you have not used PowerShell scripts before, you must open PowerShell as an Administrator and run the following command:

    set-executionpolicy unrestricted
    
    Note

    For more information about PowerShell, see the Windows PowerShell Blog and Windows PowerShell on MSDN.

  5. Open a command prompt as an administrator and run the following command to ensure WCF script maps are registered:

    %WINDIR%\Microsoft.NET\Framework\v4.0.30319\ServiceModelReg.exe -r -y
    
    Note

    For 64-bit versions of Windows, you need to run the command %WINDIR%\Microsoft.NET\Framework64\v4.0.30319\ServiceModelReg.exe -r –y in addition to the above command.

  6. Follow the instructions in BizTalk ESB Toolkit Sample Applications to install and run the samples.

Top of page

Installing the Exception Management Framework

This section describes the process for installing the ​Microsoft BizTalk ESB Toolkit Exception Management Framework.

Note

If you have already installed the Microsoft.Practices.ESB.CORE.msi file, you do not have to install the Exception Management Framework components because they are included. If you need only the Exception Management Framework components, you can install the Microsoft.Practices.ESB.ExceptionHandling.msi file.

To install the Exception Management Framework

  1. Install the ​Microsoft BizTalk ESB Toolkit .msi file appropriate for your platform. This step unpacks the files needed to install the ​Microsoft BizTalk ESB Toolkit and creates necessary registry entries. The Itinerary Designer can also be installed and registered with Visual Studio 2010. To do this, click the Tools option in the installer.

    • The ​Microsoft BizTalk ESB Toolkit .msi does not register the itinerary designer by default. Post installation, the user needs to select Install itinerary designer extensions under Start> All Programs> Microsoft BizTalk Server 2010 ESB toolkit.
    • Before uninstallation, the user needs to select Uninstall itinerary designer extensions under Start> All Programs> Microsoft BizTalk Server 2010 ESB toolkit.
  2. Import the appropriate Exception Management Framework .msi file as follows:

    • To import the Exception Management Framework with bindings:

      1. Use the Microsoft.Practices.ESB.ExceptionHandling .msi file and the BizTalk Server 2010 Administration Console. This step creates the Microsoft.Practices.ESB BizTalk Server application and register all required BizTalk Server artifacts in the BizTalk Server management database, such as pipelines and supporting assemblies.

      2. Install the Microsoft.Practices.ESB.ExceptionHandling .msi file from the ​Microsoft BizTalk ESB Toolkit install folder. This step installs the supporting core and exception handling runtime assemblies to the global assembly cache and installs the pipeline components to the appropriate folder.

    • To import the Exception Management Framework without bindings:

      1. Install the Microsoft.Practices.ESB.ExceptionHandling _NOBINDING.msi file from the ​Microsoft BizTalk ESB Toolkit install folder. This step installs the supporting core and exception handling runtime assemblies to the global assembly cache and installs the pipeline components to the appropriate folder.

Next, configure the Exception Management database and Web services.

Top of page

To configure the Exception Mangement database and Web services

  1. Navigate to the installation path (the default path is C:\Program Files\​Microsoft BizTalk ESB Toolkit 2.1\) of the ​Microsoft BizTalk ESB Toolkit and launch the ESB Configuration Tool in the bin directory (ESBConfigurationTool.exe).

  2. Configure the Exception Management database. In the ESB Configuration Tool, select the Enable Exception Management Database check box. Provide the server and database name and credentials for your environment; the default database name is EsbExceptionDb. This step creates the exception handling database with the required permissions. Optionally, if choose to use an existing database to serve as the Exception Management database, you can make that selection here.

    Note

    If you have already created exception management database as part of multi-server installation, select the Use Existing Database check box to connect to the existing database.

  3. After you finish configuring the Exception Management database, click Apply Configuration.

    Note

    When using the ESB Configuration Tool during initial installation, you must apply configuration changes to each section before you can continue to configure the next section. This process also validates each configuration section before you continue. Configuration of these sections must be completed consecutively.

  4. Configure the exception Web services. In the ESB Configuration Tool, select the Enable Exception Services check box to configure the exception Web services. Provide the user credentials for your environment; the user must be a member of the Administrators group or the BizTalk Isolated Host Users group. This step creates the two exception handling Web services that can be used by applications outside the ​Microsoft BizTalk ESB Toolkit .

  5. Configure core Web services. Using the ESB Configuration Tool, configure the core Web services. This step creates a range of Web services, including the core on-ramps and general functionality of the core, such as transformations, resolution, and Microsoft BizTalk Server operational information. This will configure the BizTalk Operations Web service used by the Exception Management Framework.

  6. Place the Microsoft.Practices.ESB.BizTalkOperations.dll file in the global assembly cache. This is located in C:\Program Files\​Microsoft BizTalk ESB Toolkit 2.1\Bin. The BizTalk Operations Web service relies on the Microsoft.Practices.ESB.BizTalkOperations.dll file which is not registered to the global assembly cache during an Exception Management Framework installation, but is registered if you install the ​Microsoft BizTalk ESB Toolkit Core.

Top of page

Installing the JMS/WMQ Components

This section describes the process for installing the ​Microsoft BizTalk ESB Toolkit JMS/WMQ Components.

To install the ESB JMS/WMQ Components

  1. Click Run on the Start menu to open a command prompt and execute the following command, replacing the <path> parameter with the full path to the .msi file you want to install (the default path and name in this release is C:\Program Files\​Microsoft BizTalk ESB Toolkit 2.1\Microsoft.Practices.ESB.JMS.msi).

    BTSTask.exe ImportApp -Package:
        "<path>\Microsoft.Practices.ESB.JMS.msi"
  2. Execute the following command to add the necessary assemblies to the global assembly cache and copy the pipeline components.

    msiexec.exe /q /i "<path>\Microsoft.Practices.ESB.JMS.msi"

Top of page

Installing the ESB Management Portal

This section describes the process for installing the ESB Management Portal from the solution project included with the ​Microsoft BizTalk ESB Toolkit .

To install the ESB Management Portal

  1. Install either the ​Microsoft BizTalk ESB Toolkit Core or the ESB Exception Management Framework as described in previous topics, and then confirm correct installation and configuration before you install the portal.

  2. Create a folder named Projects in the root of your C: drive, and create a subfolder named Microsoft.Practices.ESB within this folder.

    Note

    In the current release, the supported installation is for the files to reside in the folder C:\Projects\Microsoft.Practices.ESB. The BizTalk binding files that ship with the samples depend on this path.

  3. When you install the BizTalk ESB Toolkit, it includes a .zip file called ESBSource.zip in the installation location you specified (by default, C:\Program Files\​Microsoft BizTalk ESB Toolkit 2.1). Uncompress the ESBSource.zip file into the C:\Projects\Microsoft.Practices.ESB folder. This will create folders named Keys and Source that contain the sample key and the samples with source code. The Source folder contains the source code for the sample application, and the Keys folder contains the public keys used to sign the assemblies in the sample applications.

  4. Before you run the samples, remove the read-only attribute on the C:\Projects\Microsoft.Practices.ESB\ folder so that the samples install correctly.

  5. Run the UDDI Publisher tool (you can install it at %ESB Install Folder%\Bin\Microsoft.Practices.ESB.UDDIPublisher.exe).

  6. Navigate to \Samples\Management Portal\Install\Scripts, and then run ManagementInstall.cmd from the command prompt.

  7. Configure IIS to enable running .NET 4.0 asmx web services in classic application pool mode

    1. Open IIS Manager, click on the local computer node and then double click on the ISAPI and CGI Restrictions icon.

    2. Make sure that both ASP.NET 4.0 items Restriction value is Allowed. If not, right-click on them and select Allow.

Top of page

To verify that the ESB Management Portal has been configured

  1. Verify that the new IIS virtual directory for the portal Web application has been created by the install script and has the following settings:

    • Alias: ESB.Portal

    • Directory: C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\ESB.Portal

    • Allow the following: Read, Run Scripts (such as ASP)

    • Allow anonymous access: No

    • Application Pool:EsbPortalNetworkAppPool

  2. Verify that the following IIS virtual directories were created by the install script:

    • ESB.Exceptions.Service. This service provides access to ​Microsoft BizTalk ESB Toolkit Exception Management database.

    • ESB.BAM.Service. This service provides access to ​Microsoft BizTalk ESB Toolkit BAM information.

    • ESB.UDDI.Service.This service provides UDDI 3 query and publishing functionality.

  3. Open the Visual Studio solution named ESB.Portal.sln from the C:\Projects\Microsoft.Practices.ESB\Samples\Management Portal\ESB.Portal folder, and then make sure that the <connectionStrings> section of the Web.config file contains the correct connection strings for the ESBAdmin database.

  4. Check the portal for authentication, authorization, and general configuration settings as described in the following sections.

Note

The ESB Management Portal is not compatible with Internet Explorer 8.0. You will need to run Internet Explorer 8.0 in compatibility mode to see the menus.

Now continue to the task: Checking Portal Configuration Settings.

Top of page

Checking Portal Configuration Settings

Where necessary, you should verify and modify the authentication and authorization settings for the ESB management Portal and the general configuration settings, including the portal database connections strings. The following sections contain details of the default settings and recommendations for modifying them to suit your environment.

Top of page

Portal Authentication Settings

The ESBAdmin database contains the Universal Description, Discovery, and Integration (UDDI) information required by the portal. Two roles control access to the database:

  • ESBPortal. This role provides standard access level for portal users. By default, this role includes members of the BizTalk Application Users group.

  • ESBPortalAdmin. This role provides an elevated access level for portal administrators. By default, this role includes members of the BizTalk Server Administrators group.

Top of page

Portal Authorization Settings

The default authorization group for standard access to the portal is <local_machine>\BizTalk Application Users. You can change this to a domain-level group, or to another account, by editing the Web.config file for the portal. The following is the default setting.

<authorization>
  <allow roles="BizTalk Application Users" />
  <allow roles="BizTalk Server Administrators" />
  <deny users="*" />
</authorization>

To specify a domain-level account, change the value of the <allow> element, as shown here.

<authorization>     
  <allow roles="<your-domain-name>\BizTalk Application Users" />
  <allow roles="BizTalk Server Administrators" />
  <deny users="*" />
</authorization>

The default authorization group for administrative access to the portal is <local_machine>\BizTalk Server Administrators. You can change this to a domain-level group, or to another account, by editing the Web.config file for the portal. The following is the default setting.

<authorization>
  <allow roles="BizTalk Server Administrators" />
  <deny roles="BizTalk Application Users" />
</authorization>

To specify a domain-level account, change the value of the <allow> element, as shown here.

<authorization>
  <allow roles="<your-domain-name>\BizTalk Server Administrators" />
  <deny roles="BizTalk Application Users" />
</authorization>

Top of page

Portal Configuration Settings

The Web.config file for the portal contains a range of settings for the ESB Management Portal. These include the following:

  • The configuration of the Enterprise Library Exception Handling Application Block and Logging Application Block that the portal uses

  • The <connectionStrings> section, which contains the database connection strings

  • The <appSettings> section, which contains details of the alert severity thresholds and images, and the settings for the Microsoft Chart controls

  • The <Microsoft.Practices.ESB.Portal.Properties.Settings> custom configuration section, which contains connection settings for the UDDI Web service, Itinerary Web Service and the BizTalk Operations Web service

You must make sure that the following sections contain valid values for successful operation of the ESB Management Portal:

  • The connection string for the ESBAdmin database. This is located in the <connectionStrings> section and has the following default value.

    <add name="AdminDatabaseServer" 
         connectionString="Network Library=dbmssocn; Data Source=.;
                          Initial Catalog=ESBAdmin;
                          Integrated Security=True"
         providerName="System.Data.SqlClient" />
  • The URL of the UDDI Web service. This is located in the <Microsoft.Practices.ESB.Portal.Properties.Settings> section within the <applicationSettings> section and has the following default value.

    <setting name="Microsoft_Practices_ESB_Portal_UDDIService_UDDIService"
             serializeAs="String">
      <value>http://localhost/ESB.UDDIService/UDDIService.asmx</value>
    </setting>
  • The URL of the BizTalk Operations Web service. This is located in the <Microsoft.Practices.ESB.Portal.Properties.Settings> section within the <applicationSettings> section and has the following default value.

    <setting name="Microsoft_Practices_ESB_Portal_BizTalkOperationsService_Operations" 
             serializeAs="String">
      <value>http://localhost/ESB.BizTalkOperationsService/Operations.asmx</value>
    </setting>
  • The URL of the ESB Itinerary Web service. This is located in the <Microsoft.Practices.ESB.Portal.Properties.Settings> section within the <applicationSettings> section and has the following default value.

    <setting name="Microsoft_Practices_ESB_Portal_ProcessItinerary_Process"
        serializeAs="String">
       <value>http://localhost/ESB.ItineraryServices/ProcessItinerary.asmx</value>
       </setting>

Now continue to the next task: Installing the ESB Management Portal Alert Service.

Top of page

Installing the ESB Management Portal Alert Service

The ESB Management Portal Alert Service is a sample service that notifies users of exceptions published to the ESB Management Portal. The service polls the exception database for new exceptions and evaluates these against exception alerts that users have created in the ESB Management Portal. The service then notifies any users or groups of users that have subscribed to the alert. The service retrieves notification e-mail addresses and group memberships from Microsoft Active Directory directory service. This service has no dependency on Microsoft BizTalk Server.

Important

You need to open the portal in IE8 Compatibility mode.

To install the ESB Management Portal Alert Service

  1. If you have not already installed and configured the ESB Portal as described in the previous section, do that now.

  2. Open the Microsoft Visual Studio solution named ESB.AlertService.sln from the \Source\Samples\Management Portal\ESB.AlertService folder, and then make sure that the <connectionStrings> section of the App.config file contains the correct connection strings for the EsbExceptionDb database, as shown here.

    <connectionStrings>
      <add name="EsbExceptionDb"
           connectionString="Data Source=.; Initial Catalog=EsbExceptionDb;
                            Integrated Security=True" 
           providerName="System.Data.SqlClient"/>
    </connectionStrings>
  3. If you are using a 32-bit computer, open the ESB.AlertService.sln solution in Visual Studio and change the TargetPlatform property for the Setup project from x64 to x86.

  4. Build the ESB.AlertService.sln solution using the commands on the Build menu.

  5. Open Windows Explorer, navigate to the folder Source \Samples\Management Portal\ESB.AlertService.Install\Release\, and then run the Setup.exe file for the service.

  6. Leave all settings at their default values and click Next until the installer displays the user name and password values to configure the service account for the Alert Service. Select an account that is a member of the BizTalk Application Users group with access to both the EsbExceptionDb database and the server hosting the alert service. Type the account name in the form: <DomainName>\<UserName>

  7. Use the Fault Settings page in the portal to configure the following settings in the Configuration table of the EsbExceptionDb database:

    • Email XSLT File Absolute Path. Point this setting to the folder that contains the ESB Portal Alert Service (by default, this is located in the file C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\ESB.AlertService\Templates\EmailTransformation.xslt).

    • Enable Alert Queue Service. This setting indicates whether the alert service should run and check for new exceptions occurring that match existing alerts.

    • Alert Queue Polling Interval. This setting is the number of milliseconds for the alert service to wait between processing batches of alerts.

    • Alert Queue Batch Size. This setting is the number of exceptions that the alert service should process as one operation and match against existing exceptions.

    • Alert Queue Active Directory Cache Interval. This setting is the interval at which the alert service should refresh its cache of Active Directory information, including e-mail addresses and group memberships.

    • LDAPRoot. This setting is the LDAP connection string for your domain controller; for example, LDAP://servername.domain.com/DC=domain, DC=com.

    • Enable Alert Email Service. This setting indicates whether the alert service should send alert e-mail messages. If you disable this option, the service still processes exceptions and stores alerts in an outgoing e-mail queue table. You may prefer to use this scenario if you implement an alternative e-mail delivery service.

    • Email Server. This setting is the name of your e-mail server; for example, mail.domain.com.

    • Email From Address. This setting is the "From" e-mail address to use in alert e-mail messages.

    • Email Service Polling Interval. This setting is the number of milliseconds the e-mail service waits between sending each batch of e-mail messages.

    • Email Service Batch Size. This setting is the number of e-mail messages the e-mail service should process in a batch.

  8. Open Services from Administrative Tools and locate the BizTalk ESB Exception Notification Service. Make sure that the startup type is set to Automatic, and then start the service. To open the Services management console, click Start on the taskbar, point to All Programs, point to Administrative Tools, and then click Services (or click Start on the taskbar, and then type services.msc in the search box).

Now continue to the next task: Installing the ESB Management Portal UDDI Publishing Service.

Top of page

Installing the ESB Management Portal UDDI Publishing Service

The ESB Management Portal UDDI Publishing Service is a sample service that queries the EndPoints table of the ESBAdmin database to retrieve the Microsoft BizTalk send ports and receive locations to publish to the UDDI server. If the Auto Publish feature is enabled, the service automatically calls the ESB UDDI Web service to publish the endpoint to Universal Description, Discovery, and Integration (UDDI). If the Auto Publish feature is not enabled, the service sends a notification e-mail message to the UDDI administrator; the e-mail message advises the administrator to log on to the ESB Management Portal to publish the endpoint.

Additionally, the UDDI Publishing Service monitors changes made in the Description field of BizTalk receive locations and send ports. For example, when a developer creates or modifies a receive location or a send port, the developer can indicate that the URL configured for it must be registered with UDDI. The developer can enter the moniker uddi:// into the Description property of the receive location or a send port. The UDDI Publishing Service detects the entry, retrieves the necessary endpoint information from the BizTalk receive location or send port, and publishes it according to the UDDI registry settings configured in the ESB Management Portal.

The UDDI Publishing Service has no dependency on BizTalk Server, and it can be installed on a computer that does not have BizTalk Server installed.

Now continue to the next task: Installing the ESB Management Portal UDDI Publishing Service.

Top of page

To install the ESB Management Portal UDDI Publisher Service

  1. If you have not already installed and configured the ESB Management Portal as described in the section Installing the ESB Management Portal, do that now.

  2. Open the Visual Studio solution named ESB.UDDI.PublisherService.sln from the \Samples\Management Portal\ESB.UDDI.PublisherService folder. Make sure that the <connectionStrings> section of the App.config file contains the correct connection strings for the ESBAdmin and EsbExceptionDb databases. The following are the default settings.

    <connectionStrings>
      <add name="AdminDatabaseServer"
           connectionString="Data Source=.;
                             Integrated Security=True;
                             Initial Catalog=ESBAdmin"
           providerName="System.Data.SqlClient" />
      <add name="EsbExceptionDb" 
           connectionString="Data Source=.;
                             Initial Catalog=EsbExceptionDb;
                             Integrated Security=True"
           providerName="System.Data.SqlClient"/>
    </connectionStrings>
  3. Make sure that the <applicationSettings> section of the App.config file contains the correct addresses for the UDDIService and BizTalkOperationsService Web services. The following are the default settings.

    <applicationSettings>
      <Microsoft.Practices.ESB.UDDI.PublisherService.Properties.Settings>
        <setting name="ESB_UDDI_PublisherService_UDDIService_UDDIService"
                 serializeAs="String">
          <value>
              http://localhost/ESB.UDDIService/UDDIService.asmx
          </value>
        </setting> 
        <setting name="Microsoft_Practices_ESB_UDDI_PublisherService_BTQueryService_BizTalkQueryService"
                 serializeAs="String">    
          <value>
            http://localhost/ESB.BizTalkOperationsService/BizTalkOperationsService.asmx
          </value>
        </setting>
      </Microsoft.Practices.ESB.UDDI.PublisherService.Properties.Settings>  
    </applicationSettings>
    Note

    The UDDIService is a custom ESB Web service and should not be confused with the actual UDDI server.

  4. If you are using a 64-bit computer, open the ESB.UDDI.PublisherService.sln solution in Visual Studio and change the TargetPlatform property for the ESB.UDDI.PublisherService.Install project from x86 to x64.

  5. Build the ESB.UDDI.PublisherService.sln solution using the commands on the Build menu.

  6. Open Windows Explorer, navigate to the folder \Samples\Management Portal\ESB.UDDI.PublisherService.Install\Release, and then run the Windows Installer file named Setup.exe.

  7. Leave all settings at their default values, and then click Next until the installer displays the username and password values to configure the service account for the UDDI Publishing Service. Select an account that is a member of the BizTalk Server Administrators group and that has access to the server hosting the UDDI Publisher Service. Enter the account name in the following form: <DomainName>\<UserName>.

  8. Use the Registry Settings page in the portal to configure the following settings in the UDDI Admin table of the ESBAdmin database:

    • UDDIServer. This setting is the URL of the UDDI server; for example, http://servername/uddi.

    • Publishing Service Interval. This settings sets UDDI publishing service polling interval in milliseconds.

    • Categorization Schema. This setting defines base name of categorization schema used for publishing service endpoints to UDDI.

    • LDAP Root. This setting defines address of LDAP server.

    • Auto Publish. This setting indicates whether the service will automatically publish endpoints to the UDDI server or if administrative approval is required.

    • Anonymous. This setting indicates whether to use anonymous access to connect to the UDDI server or to use the UDDI Publisher Service account.

    • Notification Enabled. This setting indicates whether to send endpoint update notification e-mail messages.

    • SMTP Server. This setting is the address of the SMTP server that will send notification e-mail messages.

    • Notification E-Mail. This setting is the e-mail address to which to send endpoint update notification e-mail messages.

    • E-Mail From Address. This setting is the From address for notification e-mail messages.

    • E-Mail Subject. This setting is the text to display in the subject line of notification e-mail messages.

    • E-Mail Body. This setting is the text for the body of notification e-mail messages.

    • Contact Name. This setting is name of the UDDI administrator to notify of endpoint update requests.

    • Contact E-Mail. This setting is the e-mail address of the UDDI administrator to notify of endpoint update requests.

  9. Open Services from Administrative Tools and locate the BizTalk ESB UDDI Publishing Service. Make sure that the startup type is set to Automatic, and then start the service. To open the Services management console, click Start on the taskbar, point to All Programs, point to Administrative Tools, and then click Services (or click Start on the taskbar, and then type services.msc in the search box).

If you run into issues, see Troubleshooting Portal Installation and Configuration.

Top of page

Configuring Exception Management InfoPath Form Template Shares

You must share the folders that contain the InfoPath templates that the ​Microsoft BizTalk ESB Toolkit Exception Management components and samples use for rendering exception information. You must create a share named Publish for the InfoPath Exception Handling templates and a share named PublishResubmit for the InfoPath Publish and Resubmit template.

To configure InfoPath Form Template shares

  1. If you have not already done so, unpack the ESBSource.zip file containing the samples to C:\Projects\Microsoft.Practices.ESB.

  2. In Windows Explorer, navigate to the folder C:\Projects\Microsoft.Practices.ESB\Projects\Microsoft.Practices.ESB\Source\Samples\Exception Handling\Source\ESB.ExceptionHandling.InfoPath.Reporting\Publish. This folder contains the InfoPath template used to render exception information serialized by the ​Microsoft BizTalk ESB Toolkit Exception Management Framework.

  3. Share this Publish folder using the name Publish, with Read permission for all users. In Windows Server 2008 R2, you can do the following:

    • Right-click the Publish folder in Windows Explorer, click Properties, and then click the Sharing tab.

    • Click Share this folder and accept the default value Publish (the folder name).

    • Click the Permissions button and confirm that the Read check box contains a check mark for the Everyone account group.

    • Click OK in each of the two dialog boxes.

  4. In Windows Explorer, navigate to the folder Projects\Microsoft.Practices.ESB\Source\Samples\Exception Handling\Source\ESB.ExceptionHandling.InfoPath.Resubmit\Publish within the folder where you installed the ​Microsoft BizTalk ESB Toolkit . This folder contains the InfoPath template used to demonstrate the Repair and Resubmit use case within the sample application.

  5. Share this Publish folder using the name PublishResubmit, with Read permission for all users, as described in step 2.

Top of page

Troubleshooting Portal Installation and Configuration

Use the following lists to help you resolve any errors you encounter while installing or running the ESB Management Portal:

  • BizTalk Server Packages:

    • If BizTalk Server hosts are configured in your environment as trusted, import BizTalk Toolkit installer packages with no binding information.

    • Modify the appropriate binding file located in the ​Microsoft BizTalk ESB Toolkit Bindings folder and then import it using the BizTalk Administration tool.

  • Databases:

    • Make sure that the ESB Core or the ESB Exception Handling installation process created the EsbExceptionDb database.

    • Make sure that the portal installation process created the ESBAdmin database.

    • Make sure that the connection strings in the Web.config file for the portal point to the correct database server.

    • Make sure that the following users exist in the ESBAdmin and EsbExceptionDb databases:

      Users

      BizTalk Application Users - member of ESBPortal role

      BizTalk Server Administrators - member of ESBPortalAdmin role

  • Services:

    • Make sure that the ESB Toolkit installation process created and configured the ESB.BizTalkOperationsService Web service.

    • Make sure that the URLs in the Web.config file for the portal are correct and point to valid service endpoints.

    • Make sure that the portal installation script created the IIS application pool and virtual directory for the portal.

    • Make sure that the portal application pool runs under the identity of the built-in NETWORK SERVICE account.

    • Make sure that the Web.config file for the portal contains the setting <identity impersonate="true" />.

  • General:

    • Make sure that you access the portal under the context of an account that is a member of the BizTalk Application Users or BizTalk Server Administrators group.

    • Open the MySettings tab of the portal and make sure that the configuration of the application(s) to display specifies an appropriate default date and time range.

Top of page

Security Considerations

If a Web site or service hosted in Internet Information Services (IIS) impersonates a user to authenticate to back-end resources and if IIS or the back-end service that IIS consumes is running with a custom identity such as a domain account, the following steps should be performed.

To create a service principal name for IIS that impersonates a user

  1. Log on to the domain controller.

  2. Open a command prompt.

  3. Run the following set of commands:

    • If the application pool under which the Web site runs uses a domain identity, run the following commands:

      setspn -A HTTP/netbiosName domainName\userName

      setspn -A HTTP/FullyQualifiedName domainName\userName

      The following provides more information about the preceding commands:

      • userName is the domain identity of the application pool.

      • netbiosName and FullyQualifiedName are the flat and DNS names of the Web server computer that is impersonating the user and consuming back-end services.

      • domainName is the domain name of Active Directory.

      • HTTP is the service for which you are registering the Service Principal Name (SPN).

      By running these commands, the user can use any of the names when calling the Web or Windows Communication Foundation (WCF) service.

      Note

      If the application pool runs under the network service, this procedure is not necessary, because the network service will use the computer account to authenticate with Kerberos. There are already SPNs created for the HTTP and other services running in the computer associated with the computer account.

Top of page

To create a service principal name for SQL that is consumed by IIS that impersonates the user

  1. Log on to the domain controller.

  2. Open a command prompt.

  3. Run the following set of commands:

    • If SQL is running under a domain identity, run the following commands:

      setspn -A MSSQLsvc/netbiosName domainName\userName

      setspn -A MSSQLsvc/FullyQualifiedName domainName\userName

      The following provides more information about the preceding commands:

      1. userName is the domain identity that SQL is running under

      2. netbiosName and FullyQualifiedName are the flat and DNS names of SQL server

      3. domainName is the domain name of Active Directory.

      4. MSSQLsvc is the SQL service for which you are registering the Service Principal Name (SPN).

      By running these commands, the user can use any of the names when connecting to an instance of Microsoft SQL Server.

      Note

      If the SQL Server runs under local system or network service, this procedure is not necessary, because network service will use the computer account to authenticate with Kerberos. There are already SPNS created for the MSSQLsvc and other services running in the computer associated with the computer account.

Top of page

To create a service principal name for IIS that is consumed by another IIS that impersonates a user

  1. Log on to the domain controller.

  2. Open a command prompt.

  3. Run the following set of commands:

    • If the application pool under which the Web site runs uses a domain identity, run the following commands:

      setspn -A HTTP/netbiosName domainName\userName

      setspn -A HTTP/FullyQualifiedName domainName\userName

      The following provides more information about the preceding commands:

      • userName is the domain identity of the application pool.

      • netbiosName and FullyQualifiedName are the flat and DNS names of the Web server computer that is impersonating the user and consuming backend services.

      • domainName is the domain name of Active Directory.

      • HTTP is the service for which you are registering the Service Principal Name (SPN).

      By running these commands, the user can use any of the names when calling the Web or Windows Communication Foundation (WCF) service.

      Note

      If the application pool runs under the network service, this procedure is not necessary, because the network service will use the computer account to authenticate with Kerberos. There are already SPNs created for the HTTP and other services running in the computer associated with the computer account.

Top of page

To configure the account for trusted for delegation

  1. Log on to the domain controller.

  2. Start the Microsoft Management Console (MMC) Active Directory Users and Computers snap-in.

  3. In the left pane of the MMC snap-in, if the application pool runs under Network Service, click the Computers node; if the application pool runs under Domain Identity, click Users.

  4. In the right pane, double-click your Web server computer or the account identity under which your application pool runs to display the Properties dialog box.

  5. On the Delegation tab of the Properties dialog box for the WCF server computer, Do not trust the computer for delegation is selected by default. To use constrained delegation, select Trust this computer for delegation to specified services only. You can specify precisely which service or services can be accessed in the bottom pane.

  6. Under Trust this computer for delegation to specified services only, use the default option (Use Kerberos only).

  7. Click Add to display the Add Services dialog box.

  8. Click Users or Computers.

  9. In the Select Users or Computers dialog box, type the name of your database server computer or Web server if you are running SQL Server/Web server as System or Network Service. Alternately, if you are running SQL Server using a custom domain account, enter that account name instead, and then click OK. You will see all the service principal names configured for the selected user or computer account. To restrict access to SQL Server, select MSSQLSvc service, and then click OK.

Note

When creating a reference to a Web service or WCF service, use the NetBIOS name or fully qualified name of the host. Using an IP address or local host will cause Windows to switch to NTLM and impersonation will fail.

Top of page

General Multi-box Installation Steps

ACTIVE DIRECTORY SERVER INSTALLATION STEPS

  1. Create standard service users

    1. BizTalk service account (used for Rule Engine Update Service, BizTalk Host Instance, BizTalk Isolated Host Instance and BAM Notification Services, BAM Management Web Service and BAM Application Pool)

    2. SSO service account

    3. ESB service account

    4. SQL service account

    5. UDDI service account

  2. Create BizTalk user groups

    1. BizTalk Server Administrators

      1. Add domain user which will install BizTalk to the group.

      2. Add ESB service account to the group.

    2. BizTalk Server Operators

    3. BizTalk Server B2B Operators

    4. BizTalk Application Users

      1. Add BizTalk Service account to the group.

    5. BizTalk Isolated Host Users

      1. Add BizTalk Service account to the group.

      2. Add ESB service account to the group.

  3. Create SSO user groups

    1. SSO Administrators

      1. Add SSO Service account to the group

    2. SSO Affiliate Administrators

4-Box Installation

Infrastructure Configuration

SERVERS

  • IIS Server (for ESB Portal/UDDI/BAM Portal)

  • BizTalk Server

  • SQL Server #1 (for BTS, SSO and UDDI databases)

  • SQL Server #2 (for ESB databases)

ADDITIONAL COMPUTERS

  • Active Directory Server (prerequisite)

  • Development computer (for BTS and ESB development and Portal setup build)

SQL Server #1 Installation Steps

  1. Install SQL Server 2008 R2 Prerequisites

    1. Microsoft .NET Framework 3.5.1

      1. Open Server Manager.

      2. Go to Features Node.

      3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and click Install.

  2. Install SQL Server 2008 R2

    1. Run SQL Server 2008 R2 setup logged in as a domain administrator.

    2. Select Installation and then New Installation or add features to an existing installation.

    3. Press Install to install the setup support files.

    4. Configure the Product Key.

    5. Check Database Engine Services.

    6. Check Analysis Services.

    7. Check Management Tools - Complete.

    8. Select either Default Instance or a Named instance and configure the instance root folder and click Next.

    9. Select the SQL user account to be used in the different services and define server default collation.

    10. Select the authentication mode and add the SQL Server administrator users.

    11. Select the authentication mode and add the Analysis Services administrator users.

    12. Press Install to begin the installation.

    13. Open SQL Server Configuration Manager.

    14. Go to SQL Server Network Configuration node, and select the item corresponding to your server instance.

    15. Enable TCP/IP option by right-clicking and selecting Enable.

    16. Go to SQL Server Services node and restart the instance service.

    17. Right click on SQL Server Browser, go to properties, select the Service tab and change Start Mode to Automatic if it’s not.

    18. Right click on SQL Server Browser and start the service if it’s stopped.

  3. Enable MSDTC on the server

    1. Follow this guide: http://go.microsoft.com/fwlink/?LinkID=198391

  4. Install UDDI 3 Services Prerequisites

    1. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

  5. Install UDDI 3 Services

    1. Select UDDI Services installation from Microsoft BizTalk Server 2010 setup.

    2. Check only UDDI Services Database Component.

  6. Configure Microsoft UDDI Services 3

    1. Select custom configuration.

    2. UDDI Services Database Component

      1. Select the SQL Server instance where you want to install the UDDI database.

      2. Uncheck Require SSL for publication to this UDDI services site.

SQL Server #2 Installation Steps

  1. Install Microsoft SQL Server 2008 R2 Prerequisites

    1. Microsoft .NET Framework 3.5.1

      1. Open Server Manager.

      2. Go to Features Node.

      3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and click Install.

  2. Install Microsoft SQL Server 2008 R2

    1. Run SQL Server 2008 R2 setup logged in as a domain administrator.

    2. Select Installation and then New Installation or add features to an existing installation.

    3. Press Install to install the setup support files.

    4. Configure the Product Key.

    5. Check Database Engine Services.

    6. Check Management Tools - Complete.

    7. Select either Default Instance or a Named instance and configure the instance root folder and click Next.

    8. Select the SQL user account to be used in the different services and define server default collation.

    9. Select the authentication mode and add the SQL Server administrator users.

    10. Select the authentication mode and add the Analysis Services administrator users.

    11. Press Install to begin the installation.

    12. Open SQL Server Configuration Manager.

    13. Go to SQL Server Network Configuration node, and select the item corresponding to your server instance.

    14. Enable TCP/IP option by right-clicking and selecting Enable.

    15. Go to SQL Server Services node and restart the instance service.

    16. Right click on SQL Server Browser, go to properties, select the Service tab and change Start Mode to Automatic if it’s not.

    17. Right click on SQL Server Browser and start the service if it’s stopped.

  3. Enable MSDTC on the server

    1. Follow this guide: http://go.microsoft.com/fwlink/?LinkID=198391

BizTalk Server Installation Steps

  1. Install Microsoft BizTalk Server 2010 Prerequisites

    1. Install Internet Information Services (IIS) 7.0

      1. Open Server Manager.

      2. Go to Roles Node.

      3. Select Web Server (IIS).

      4. Leave the default checks and additionally check ASP.NET, Windows Authentication and IIS 6 Management Compatibility.

    2. Microsoft .NET Framework 3.5.1 and WCF HTTP Activation

      1. Open Server Manager.

      2. Go to Features Node.

      3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features select Microsoft .NET Framework 3.5.1 node and HTTP Activation inside the WCF Activation node and click Install.

    3. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

    4. Microsoft SQL XML 4.0 with Service Pack 1 (http://go.microsoft.com/fwlink/?LinkID=198388)

    5. Microsoft ADO MD.Net 9.0 (http://go.microsoft.com/fwlink/?LinkID=198389)

    6. Microsoft ADO MD.Net 10.0 (http://go.microsoft.com/fwlink/?LinkID=198388)

    7. Microsoft Office Web Components (http://go.microsoft.com/fwlink/?LinkID=198390)

    8. Microsoft SQL Server Complete Management Tools

      1. Run SQL Server 2008 R2 setup logged in as an administrator.

      2. Select Installation and then New Installation or add features to an existing installation.

      3. Press Install to install the setup support files.

      4. Configure the Product Key.

      5. Check Management Tools - Complete.

      6. Press Install to begin the installation.

  2. Install Microsoft BizTalk Server 2010

    1. Leave default installation components checked.

    2. Check the Project Build Component inside Additional Software and install.

  3. Enable MSDTC on the server

    Follow this guide: http://go.microsoft.com/fwlink/?LinkID=198391

  4. Configure Microsoft BizTalk Server 2010

    1. Run BizTalk Server Configuration logged in as a domain administrator.

    2. Select Custom configuration and click Continue.

    3. SSO

      1. Select Create a new SSO system.

      2. Configure SQL server name for SSO database (use SQL Server #1).

      3. Configure SSO to use the SSO service account.

      4. Configure the domain SSO Administrators and SSO Affiliate Administrators user groups.

      5. Define SSO secret master key and write it down in a secure location.

    4. Group

      1. Configure SQL server name for BizTalk databases (use SQL Server #1).

      2. Configure the domain BizTalk Server Administrators, BizTalk Server Operators and BizTalk Server B2B Operators user groups.

    5. BizTalk Runtime

      1. Leave 32-bit only checkboxes checked.

      2. Configure BizTalk Host to use the BizTalk service account.

      3. Configure BizTalk Isolated Host to use the BizTalk service account.

      4. Configure the domain BizTalk Application Users and BizTalk Isolated Host Users user groups.

    6. Business Rules Engine

      1. Configure SQL server name for Business Rule Engine database (use SQL Server #1).

      2. Configure Rule Engine Update Service to use the BizTalk service account.

    7. BAM Tools

      1. Check Analysis services for BAM Aggregations.

      2. Configure SQL server name for BAM databases (use SQL Server #1).

    8. BAM Alerts (optional)

      1. Configure BAM Notifications Service to use BizTalk service account.

      2. Configure SQL server name for BAM alerts database.

    9. BizTalk EDI/AS2 Runtime (optional)

  5. Configure IIS to enable running .NET 4.0 asmx web services in classic application pool mode

    1. Open IIS Manager, click on the local computer node and then double click on the ISAPI and CGI Restrictions icon.

    2. Make sure that both ASP.NET 4.0 items Restriction value is Allowed. If not, right-click on them and select Allow.

  6. Install Microsoft BizTalk Server 2010 ESB Toolkit Prerequisites

    1. Required

      1. Microsoft Windows SDK 7.1 for Windows 7 and .NET Framework 4 (http://go.microsoft.com/fwlink/?LinkID=199001)

  7. Install Microsoft BizTalk Server 2010 ESB Toolkit

  8. Install the Microsoft.Practices.ESB.CORE64.msi and Microsoft.Practices.ESB.JMS.msi files from the BizTalk ESB Toolkit install folder

  9. In BizTalk Server Administration console, right click on the Applications node inside the BizTalk Server Group node and select Import and MSI File. Select the Microsoft.Practices.ESB.CORE64.msi file in the BizTalk ESB Toolkit install folder to install the Microsoft.Practices.ESB application.

  10. In BizTalk Server Administration console, right click on the Applications node inside the BizTalk Server Group node and select Import and MSI File. Select the Microsoft.Practices.ESB.JMS.msi file in the BizTalk ESB Toolkit install folder to install the Microsoft.Practices.JMS application. Check the Microsoft.Practices.ESB application to add a reference to the Microsoft.Practices.ESB application.

  11. Configure SQL Service account permissions for BAM databases

    1. Inside SQL SERVER #1 follow this steps:

      1. Open SQL Server Management Studio and connect to the SQL Server.

      2. Go to Security node, right click on Logins node and click on New Login.

      3. In Login name, type in the SQL Service account full name.

      4. Go to User Mapping, check Map for the BAMStarSchema database, check db_datareader and click Ok.

  12. Deploy ESB Toolkit BAM tracking definitions

    1. Open a command prompt and go to Microsoft BizTalk Server 2010 installation folder.

    2. Go into the Tracking subfolder.

    3. Type in the following command (replace the ESB install folder path if required):

      Bm.exe deploy-all -DefinitionFile:"C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Itinerary.xml"
      
      
    4. Type in the following command (replace the ESB install folder path if required):

      Bm.exe deploy-all -DefinitionFile:"C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml"
      
      
  13. Configure Microsoft BizTalk Server 2010 ESB Toolkit (open the tool from the Start menu)

    1. Exception Database

      1. Configure SQL server name for Exception Management database (use SQL Server #2).

      2. Select the domain BizTalk Server Administrators user group.

      3. Select the domain BizTalk Application Users user group.

    2. Exception Web Services

      1. Configure Exception Web Services to use the ESB service account.

      2. Select the domain BizTalk Isolated Host Users user group.

    3. Itinerary Database

      1. Configure SQL server name for Itinerary database (use SQL Server #2).

      2. Select the domain BizTalk Isolated Host Users user group.

      3. Select the domain BizTalk Application Users user group.

      4. Select the domain BizTalk Server Administrators user group.

    4. Core Web Services

      1. Configure Core Web Services to use the ESB service account.

      2. Select the domain BizTalk Isolated Host Users user group.

  14. Configure impersonation for BizTalk Operations Service

    1. Find the line with the <identity impersonate="true"/> in the web.config file in the Web\ESB.BizTalkOperationsService and Esb.ResolverService folders inside the ESB Toolkit installation folder.

    2. Include the ESB service account credentials, for example:

      <identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />
      
  15. Assign permissions to esb.config

    1. Go to the ESB Toolkit installation folder.

    2. Select both files, right click over them and go to properties.

    3. Go to the Security tab and click on Edit.

    4. Click on Add and select the BizTalk Service User account.

    5. Click Ok to assign the permissions.

  16. Configure esb.config

    1. Go to the ESB Toolkit installation folder.

    2. Open the esb.config file.

    3. Find the line with <add name="baseUri" value="http://localhost/uddi" /> and change the localhost part to point to the IIS Server.

  17. Configure ESB Exception Send port

    1. Open BizTalk Server Administration Console.

    2. Open the Microsoft.Practices.ESB application and select the Send Ports node.

    3. Double-click on the ALL.Exceptions send port and click on Configure.

    4. Modify the connection string to match the ESB Exception database location (SQL Server #2).

  18. Restart BizTalk Host Instance

    1. Inside the BizTalk Server Administration Console, go to Platform Settings node.

    2. Click on Host Instances node.

    3. Right-click on the main BizTalk Server host instance and click on Restart.

  19. Prepare ESB Portal prerequisite sample applications

    1. Extract ESBSource.zip (found in Microsoft BizTalk ESB Toolkit 2.1 installation folder) to a new folder.

    2. Remove the read-only flag for the folder, its subfolders and files.

    3. Open a command-line prompt.

    4. Go to the Keys subfolder inside the folder you just extracted.

    5. Run the following command to create a Strong Name Key:

      "%PROGRAMFILES%\ Microsoft SDKs\Windows\v7.1\Bin\sn.exe" -k Microsoft.Practices.ESB.snk
      
  20. Install ESB Portal prerequisite sample applications

    1. Open a command-line prompt.

    2. Run the following commands:

      %WINDIR%\syswow64\windowspowershell\v1.0\powershell.exe Set-ExecutionPolicy unrestricted
      powershell.exe Set-ExecutionPolicy unrestricted
      path %PATH%;%PROGRAMFILES%\Microsoft SDKs\Windows\v7.1\Bin
      
      
    3. Install DynamicResolution sample

      1. In the same command prompt, go to the Source\Samples\DynamicResolution\Install\Scripts folder.

      2. Run the following command and type in the ESB service account credentials: Setup_bin.cmd

      3. Leave the command prompt open.

    4. Install Itinerary sample

      1. In the same command prompt, go to the Source\Samples\Itinerary\Install\Scripts folder.

      2. If you changed the default ESB Itinerary Database name, you need to replace every appearance of ESBItineraryDb with the custom name in the following file: Source\Samples\Itinerary\ItineraryDb\ServerItineraries\CreateSampleItineraries.sql.

      3. Run the following command replacing %SQLSERVER% with the correct server and instance name for the ESB Itinerary Db (use SQL Server #2):

        Setup_bin.cmd %SQLSERVER%
        
      4. Leave the command prompt open.

    5. Install MultipleWebServices sample

      1. In the same command prompt, go to the Source\Samples\MultipleWebServices\Install\Scripts folder.

      2. Run the following command:

        Setup_bin.cmd
        
        
      3. Close the command prompt.

IIS Server Installation Steps

  1. Install Microsoft BizTalk Server 2010 ESB Toolkit Prerequisites

    1. Required

      1. Install Internet Information Services (IIS) 7.0

        1. Open Server Manager.

        2. Go to Roles Node.

        3. Select Web Server (IIS).

        4. Leave the default checks and additionally check ASP.NET, Windows Authentication and IIS 6 Management Compatibility.

      2. Microsoft .NET Framework 3.5.1

        1. Open Server Manager.

        2. Go to Features Node.

        3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and click Install.

      3. Microsoft Chart Controls for Microsoft .NET Framework 3.5 (http://go.microsoft.com/fwlink/?LinkID=185952)

  2. Install Microsoft BizTalk Server 2010 ESB Toolkit

  3. Install UDDI 3 Services Prerequisites

    1. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

  4. Install UDDI 3 Services

    1. Select UDDI Services installation from Microsoft BizTalk 2010 setup.

    2. Leave defaults checked except for UDDI Services Database Component.

  5. Configure Microsoft UDDI Services 3

    1. Select custom configuration.

    2. UDDI Services Web Application

      1. Select the SQL Server instance where you installed the UDDI database (use SQL Server #1).

      2. Type in the credentials for the UDDI service account.

    3. Configure UDDI roles

      1. Open UDDI Services Management Console.

      2. Right-click on the UDDI node and click on Properties.

      3. Select the Roles tab.

      4. Pick the domain BizTalk Server Administrators group for the 4 items.

  6. Publish ESB Toolkit endpoints in UDDI

    1. Go to the ESB Toolkit 2.1 installation folder.

    2. Inside of the bin subfolder, open the Microsoft.Practices.ESB.UDDIPublisher.exe.config file.

    3. Replace every appearance of http://localhost/uddi with the correct URL to your UDDI services installation (only if you changed the URL for UDDI web application).

    4. Hold shift key and right-click on the Microsoft.Practices.ESB.UDDIPublisher.exe file.

    5. Click on Run as different user and when asked for credentials type in the ESB Service account credentials.

    6. When asked for UDDI authentication usage, press Enter.

  7. Prepare ESB Portal installation

    1. Create ESB Portal, ESB UDDI Publisher Service and ESB Alert Service setups

      1. Inside the Development computer follow these steps:

        1. Extract ESBSource.zip (found in Microsoft BizTalk ESB Toolkit 2.1 installation folder) to a new folder.

        2. Remove the read-only flag for the folder, its subfolders and files.

        3. Inside this folder, go to the Keys folder and create a Microsoft.Practices.ESB.snk file, by following the instructions in the Readme.txt file.

        4. Create ESB Portal Setup

          1. Go to the Source\Samples\Management Portal\ESB.Portal folder and open the ESB.Portal.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the ESB.Portal.Setup project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.Portal.Setup\Debug or Source\Samples\Management Portal\ESB.Portal.Setup\Release and copy the ESB.Portal.msi and Setup.exe that were just created to the IIS Server.

        5. Create ESB UDDI Publisher Service Setup

          1. Go to the Source\Samples\Management Portal\ESB.UDDI.PublisherService folder and open the ESB.UDDI.PublisherService.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the ESB.UDDI.PublisherService.Install project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.UDDI.PublisherService.Install\Debug or Source\Samples\Management Portal\ESB.UDDI.PublisherService.Install\Release and copy the BizTalk ESB UDDI Publishing.msi and Setup.exe that were just created to the IIS Server.

        6. Create ESB Alert Service Setup

          1. Go to the Source\Samples\Management Portal\ESB.AlertService folder and open the ESB.AlertService.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the Setup project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.AlertService.Install\Debug or Source\Samples\Management Portal\ESB.AlertService.Install\Release and copy the BizTalk ESB Exception Notification.msi and Setup.exe that were just created to the IIS Server.

    2. Open Internet Information Services Manager and create a new application pool, named EsbPortalNetworkAppPool and configure it to run under Network Service account.

    3. Copy the Source folder with the keys from the Development computer into the IIS server.

  8. Install ESB Portal Administration database

    1. Inside SQL SERVER #2 follow these steps:

      1. Open SQL Server Management Studio and connect to the server.

      2. Open a new query.

      3. Copy the code from Source\Samples\Management Portal\SQL\ESB.Administration.Database.sql in the new query.

        1. If your BizTalk user groups have custom names, then you need to change them inside this file, find and replace BizTalk Application Users and BizTalk Server Administrators with the custom names.

        2. If you want to change the database default name, replace every instance of ESBAdmin in the query with your custom name.

      4. Run the query, and the ESBAdmin database will be deployed.

  9. Install ESB Portal

    1. Run the ESB Portal setup.exe file you previously built and when asked for the Application Pool, select the EsbPortalNetworkAppPool one. This will create all the required virtual directories for the ESB Management Portal in the website you chose.

  10. Install the ESB Portal Alert Service:

    1. Run the Alert Service setup.exe file you previously built.

    2. When asked, type in the ESB Service account credentials.

  11. Install the ESB UDDI Publisher Service:

    1. Run the UDDI Publisher setup.exe file you previously built.

    2. When asked, type in the ESB Service account credentials.

  12. Configure ESB Portal

    1. Go to the website root folder and find the ESB.Portal folder. Open the web.config file and do the following:

      1. Properly configure the AdminDatabaseServer and EsbExceptionDb connection strings to point to SQL Server #2 and the right database names, for example:

        1. <add name="AdminDatabaseServer" connectionString="Data Source=SQLServer2\InstanceName;Integrated Security=True;Initial Catalog=ESBAdmin;" providerName="System.Data.SqlClient"/>
          
          
        2. <add name="EsbExceptionDb" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
          
      2. Find and replace BizTalk Application Users and BizTalk Server Administrators with the right domain group names in the authorization node.

      3. Find the appearances of http://localhost/ESB.BizTalkOperationsService/Operations.asmx, http://localhost/ESB.ItineraryServices/ProcessItinerary.asmx andhttp://localhost/ESB.ItineraryServices.WCF/ProcessItinerary.svc and replace the localhost part with the name of your BizTalk Server computer.

      4. Find the line with the <identity impersonate="true"/> and include the ESB service account credentials, for example:<identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />

      5. Find the client node and inside of it the endpoint node where the address attribute contains ESB.ItineraryServices.WCF/ProcessItinerary.svc. Replace the final /> of the node with ><identity><userPrincipalName value="DOMAIN\USERNAME"/></identity></endpoint>, configuring the proper domain and username for the ESB service account. For example, the resulting configuration should be:

        <endpoint address="http://BIZTALKSERVER/ESB.ItineraryServices.WCF/ProcessItinerary.svc" binding="wsHttpBinding" bindingConfiguration="WSHttpBinding_ITwoWayAsyncVoid" contract="ProcessRequest" name="WSHttpBinding_ITwoWayAsyncVoid"><identity><userPrincipalName value="DOMAIN\USERNAME" /></identity></endpoint>
        
        
    2. Go to the Admin folder inside the ESB.Portal folder. Open the web.config file and do the following:

      1. Find and replace BizTalk Application Users and BizTalk Server Administrators with the right domain group names in the authorization node.

    3. Go to the ESB.Exceptions.Service folder in the same location. Open the web.config file and do the following:

      1. Properly configure the EsbExceptionDbConnectionString connection string to point to SQL Server #2 and the right database name, for example:

        <add name="EsbExceptionDbConnectionString" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
        
        
    4. Go to the ESB.BAM.Service folder in the same location. Open the web.config file and do the following:

      1. Properly configure the BAMEventSource connection string to point to SQL Server #1 and the right database name for BAM Primary Import, for example:

        <add name="BAMEventSource" connectionString="Data Source=SQLServer1\InstanceName;Initial Catalog=BAMPrimaryImport;Integrated Security=True;" providerName="System.Data.SqlClient"/>
        
        
    5. Go to the ESB.UDDI.Service folder in the same location. Open the web.config file and do the following:

      1. Replace every appearance of http://localhost/uddi with the correct URL to your UDDI services installation (only if you changed the URL for UDDI web application).

      2. Find the line with the <identity impersonate="true"/> and include the ESB service account credentials, for example:

        <identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />
        
        
    6. In Internet Information Services Manager, go to the Authentication configuration for all the ESB.Portal, ESB.Exceptions.Service and ESB.BAM.Service applications, disable Anonymous Authentication and enable Windows Authentication.

    7. In Internet Information Services Manager, go to the Basic settings for the ESB.Exceptions.Service and ESB.BAM.Service, and set the Application pool to EsbPortalNetworkAppPool.

  13. Configure the ESB Portal Alert Service:

    1. Go to the Alert Service installation folder and open BizTalk ESB Exception Notification.exe.config file.

    2. Properly configure the EsbExceptionDb connection string to point to SQL Server #2 and the right database name, for example:

      <add name="EsbExceptionDb" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
      
      
  14. Configure the ESB UDDI Publisher Service:

    1. Go to the UDDI Publisher Service installation folder and open BizTalk ESB UDDI Publishing.exe.config file.

    2. Properly configure the AdminDatabaseServer and EsbExceptionDb connection strings to point to SQL Server #2 and the right database names, for example:

      <add name="AdminDatabaseServer" connectionString="Data Source=SQLServer2\InstanceName;Integrated Security=True;Initial Catalog=ESBAdmin;" providerName="System.Data.SqlClient"/>
      <add name="EsbExceptionDb" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
      
      
    3. Find the appearances of http://localhost/ESB.BizTalkOperationsService/Operations.asmx and replace the localhost part with the name of your BizTalk Server computer.

3-Box Installation

Infrastructure Configuration

SERVERS

  • IIS Server (for ESB Portal/UDDI/BAM Portal)

  • BizTalk Server

  • SQL Server (for BTS, SSO, UDDI and ESB databases)

ADDITIONAL COMPUTERS

  • Active Directory Server (prerequisite)

  • Development computer (for BTS and ESB development and Portal setup build)

SQL Server Installation Steps

  1. Install SQL Server 2008 R2 Prerequisites

    1. Microsoft .NET Framework 3.5.1

      1. Open Server Manager.

      2. Go to Features Node.

      3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and click Install.

    2. Install SQL Server 2008 R2

      1. Run SQL Server 2008 R2 setup logged in as a domain administrator.

      2. Select Installation and then New Installation or add features to an existing installation.

      3. Press Install to install the setup support files.

      4. Configure the Product Key.

      5. Check Database Engine Services.

      6. Check Analysis Services.

      7. Check Management Tools - Complete.

      8. Select either Default Instance or a Named instance and configure the instance root folder and click Next.

      9. Select the SQL user account to be used in the different services and define server default collation.

      10. Select the authentication mode and add the SQL Server administrator users.

      11. Select the authentication mode and add the Analysis Services administrator users.

      12. Press Install to begin the installation.

      13. Open SQL Server Configuration Manager.

      14. Go to SQL Server Network Configuration node, and select the item corresponding to your server instance.

      15. Enable TCP/IP option by right-clicking and selecting Enable.

      16. Go to SQL Server Services node and restart the instance service.

      17. Right click on SQL Server Browser, go to properties, select the Service tab and change Start Mode to Automatic if it’s not.

      18. Right click on SQL Server Browser and start the service if it’s stopped.

    3. Enable MSDTC on the server

      1. Follow this guide: http://go.microsoft.com/fwlink/?LinkID=198391

    4. Install UDDI 3 Services Prerequisites

      1. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

    5. Install UDDI 3 Services

      1. Select UDDI Services installation from Microsoft BizTalk Server 2010 setup.

      2. Check only UDDI Services Database Component.

    6. Configure Microsoft UDDI Services 3

      1. Select custom configuration.

      2. UDDI Services Database Component

        1. Select the SQL Server instance where you want to install the UDDI database.

        2. Uncheck Require SSL for publication to this UDDI services site.

BizTalk Server Installation Steps

  1. Install Microsoft BizTalk Server 2010 Prerequisites

    1. Install Internet Information Services (IIS) 7.0

      1. Open Server Manager.

      2. Go to Roles Node.

      3. Select Web Server (IIS).

      4. Leave the default checks and additionally check ASP.NET, Windows Authentication and IIS 6 Management Compatibility.

    2. Microsoft .NET Framework 3.5.1 and WCF HTTP Activation

      1. Open Server Manager.

      2. Go to Features Node.

      3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features select Microsoft .NET Framework 3.5.1 node and HTTP Activation inside the WCF Activation node and click Install.

    3. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

    4. Microsoft SQL XML 4.0 with Service Pack 1 (http://go.microsoft.com/fwlink/?LinkID=198388)

    5. Microsoft ADO MD.Net 9.0 (http://go.microsoft.com/fwlink/?LinkID=198389)

    6. Microsoft ADO MD.Net 10.0 (http://go.microsoft.com/fwlink/?LinkID=198388)

    7. Microsoft Office Web Components (http://go.microsoft.com/fwlink/?LinkID=198390)

    8. Microsoft SQL Server Complete Management Tools

      1. Run SQL Server 2008 R2 setup logged in as an administrator.

      2. Select Installation and then New Installation or add features to an existing installation.

      3. Press Install to install the setup support files.

      4. Configure the Product Key.

      5. Check Management Tools - Complete.

      6. Press Install to begin the installation.

  2. Install Microsoft BizTalk Server 2010

    1. Leave default installation components checked.

    2. Check the Project Build Component inside Additional Software and install.

  3. Enable MSDTC on the server

    Follow this guide: http://go.microsoft.com/fwlink/?LinkID=198391

  4. Configure Microsoft BizTalk Server 2010

    1. Run BizTalk Server Configuration logged in as a domain administrator.

    2. Select Custom configuration and click Continue.

    3. SSO

      1. Select Create a new SSO system.

      2. Configure SQL server name for SSO database (use SQL Server #1).

      3. Configure SSO to use the SSO service account.

      4. Configure the domain SSO Administrators and SSO Affiliate Administrators user groups.

      5. Define SSO secret master key and write it down in a secure location.

    4. Group

      1. Configure SQL server name for BizTalk databases (use SQL Server #1).

      2. Configure the domain BizTalk Server Administrators, BizTalk Server Operators and BizTalk Server B2B Operators user groups.

    5. BizTalk Runtime

      1. Leave 32-bit only checkboxes checked.

      2. Configure BizTalk Host to use the BizTalk service account.

      3. Configure BizTalk Isolated Host to use the BizTalk service account.

      4. Configure the domain BizTalk Application Users and BizTalk Isolated Host Users user groups.

    6. Business Rules Engine

      1. Configure SQL server name for Business Rule Engine database (use SQL Server #1).

      2. Configure Rule Engine Update Service to use the BizTalk service account.

    7. BAM Tools

      1. Check Analysis services for BAM Aggregations.

      2. Configure SQL server name for BAM databases (use SQL Server #1).

    8. BAM Alerts (optional)

      1. Configure BAM Notifications Service to use BizTalk service account.

      2. Configure SQL server name for BAM alerts database.

    9. BizTalk EDI/AS2 Runtime (optional)

  5. Configure IIS to enable running .NET 4.0 asmx web services in classic application pool mode

    1. Open IIS Manager, click on the local computer node and then double click on the ISAPI and CGI Restrictions icon.

    2. Make sure that both ASP.NET 4.0 items Restriction value is Allowed. If not, right-click on them and select Allow.

  6. Install Microsoft BizTalk Server 2010 ESB Toolkit Prerequisites

    1. Required

      1. Microsoft Windows SDK 7.1 for Windows 7 and .NET Framework 4 (http://go.microsoft.com/fwlink/?LinkID=199001)

  7. Install Microsoft BizTalk Server 2010 ESB Toolkit

  8. Install the Microsoft.Practices.ESB.CORE64.msi and Microsoft.Practices.ESB.JMS.msi files from the BizTalk ESB Toolkit install folder

  9. In BizTalk Server Administration console, right click on the Applications node inside the BizTalk Server Group node and select Import and MSI File. Select the Microsoft.Practices.ESB.CORE64.msi file in the BizTalk ESB Toolkit install folder to install the Microsoft.Practices.ESB application.

  10. In BizTalk Server Administration console, right click on the Applications node inside the BizTalk Server Group node and select Import and MSI File. Select the Microsoft.Practices.ESB.JMS.msi file in the BizTalk ESB Toolkit install folder to install the Microsoft.Practices.JMS application. Check the Microsoft.Practices.ESB application to add a reference to the Microsoft.Practices.ESB application.

  11. Configure SQL Service account permissions for BAM databases

    1. Inside SQL SERVER #1 follow these steps:

      1. Open SQL Server Management Studio and connect to the SQL Server.

      2. Go to Security node, right click on Logins node and click on New Login.

      3. In Login name, type in the SQL Service account full name.

      4. Go to User Mapping, check Map for the BAMStarSchema database, check db_datareader and click Ok.

  12. Deploy ESB Toolkit BAM tracking definitions

    1. Open a command prompt and go to Microsoft BizTalk Server 2010 installation folder.

    2. Go into the Tracking subfolder.

    3. Type in the following command (replace the ESB install folder path if required):

      Bm.exe deploy-all -DefinitionFile:"C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Itinerary.xml"
      
      
    4. Type in the following command (replace the ESB install folder path if required):

      Bm.exe deploy-all -DefinitionFile:"C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml"
      
      
  13. Configure Microsoft BizTalk Server 2010 ESB Toolkit (open the tool from the Start menu)

    1. Exception Database

      1. Configure SQL server name for Exception Management database (use SQL Server #2).

      2. Select the domain BizTalk Server Administrators user group.

      3. Select the domain BizTalk Application Users user group.

    2. Exception Web Services

      1. Configure Exception Web Services to use the ESB service account.

      2. Select the domain BizTalk Isolated Host Users user group.

    3. Itinerary Database

      1. Configure SQL server name for Itinerary database (use SQL Server #2).

      2. Select the domain BizTalk Isolated Host Users user group.

      3. Select the domain BizTalk Application Users user group.

      4. Select the domain BizTalk Server Administrators user group.

    4. Core Web Services

      1. Configure Core Web Services to use the ESB service account.

      2. Select the domain BizTalk Isolated Host Users user group.

  14. Configure impersonation for BizTalk Operations Service

    1. Find the line with the <identity impersonate="true"/> in the web.config file in the Web\ESB.BizTalkOperationsService and Esb.ResolverService folders inside the ESB Toolkit installation folder.

    2. Include the ESB service account credentials, for example:

      <identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />
      
  15. Assign permissions to esb.config

    1. Go to the ESB Toolkit installation folder.

    2. Select both files, right click over them and go to properties.

    3. Go to the Security tab and click on Edit.

    4. Click on Add and select the BizTalk Service User account.

    5. Click Ok to assign the permissions.

  16. Configure esb.config

    1. Go to the ESB Toolkit installation folder.

    2. Open the esb.config file.

    3. Find the line with <add name="baseUri" value="http://localhost/uddi" /> and change the localhost part to point to the IIS Server.

  17. Configure ESB Exception Send port

    1. Open BizTalk Server Administration Console.

    2. Open the Microsoft.Practices.ESB application and select the Send Ports node.

    3. Double-click on the ALL.Exceptions send port and click on Configure.

    4. Modify the connection string to match the ESB Exception database location (SQL Server #2).

  18. Restart BizTalk Host Instance

    1. Inside the BizTalk Server Administration Console, go to Platform Settings node.

    2. Click on Host Instances node.

    3. Right-click on the main BizTalk Server host instance and click on Restart.

  19. Prepare ESB Portal prerequisite sample applications

    1. Extract ESBSource.zip (found in Microsoft BizTalk ESB Toolkit 2.1 installation folder) to a new folder.

    2. Remove the read-only flag for the folder, its subfolders and files.

    3. Open a command-line prompt.

    4. Go to the Keys subfolder inside the folder you just extracted.

    5. Run the following command to create a Strong Name Key:

      "%PROGRAMFILES%\ Microsoft SDKs\Windows\v7.1\Bin\sn.exe" -k Microsoft.Practices.ESB.snk
      
  20. Install ESB Portal prerequisite sample applications

    1. Open a command-line prompt.

    2. Run the following commands:

      %WINDIR%\syswow64\windowspowershell\v1.0\powershell.exe Set-ExecutionPolicy unrestricted
      powershell.exe Set-ExecutionPolicy unrestricted
      path %PATH%;%PROGRAMFILES%\Microsoft SDKs\Windows\v7.1\Bin
      
      
    3. Install DynamicResolution sample

      1. In the same command prompt, go to the Source\Samples\DynamicResolution\Install\Scripts folder.

      2. Run the following command and type in the ESB service account credentials: Setup_bin.cmd

      3. Leave the command prompt open.

    4. Install Itinerary sample

      1. In the same command prompt, go to the Source\Samples\Itinerary\Install\Scripts folder.

      2. If you changed the default ESB Itinerary Database name, you need to replace every appearance of ESBItineraryDb with the custom name in the following file: Source\Samples\Itinerary\ItineraryDb\ServerItineraries\CreateSampleItineraries.sql.

      3. Run the following command replacing %SQLSERVER% with the correct server and instance name for the ESB Itinerary Db (use SQL Server #2):

        Setup_bin.cmd %SQLSERVER%
        
      4. Leave the command prompt open.

    5. Install MultipleWebServices sample

      1. In the same command prompt, go to the Source\Samples\MultipleWebServices\Install\Scripts folder.

      2. Run the following command:

        Setup_bin.cmd
        
        
      3. Close the command prompt.

IIS Server Installation Steps

  1. Install Microsoft BizTalk Server 2010 ESB Toolkit Prerequisites

    1. Required

      1. Install Internet Information Services (IIS) 7.0

        1. Open Server Manager.

        2. Go to Roles Node.

        3. Select Web Server (IIS).

        4. Leave the default checks and additionally check ASP.NET, Windows Authentication and IIS 6 Management Compatibility.

      2. Microsoft .NET Framework 3.5.1

        1. Open Server Manager.

        2. Go to Features Node.

        3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and click Install.

      3. Microsoft Chart Controls for Microsoft .NET Framework 3.5 (http://go.microsoft.com/fwlink/?LinkID=185952)

  2. Install Microsoft BizTalk Server 2010 ESB Toolkit

  3. Install UDDI 3 Services Prerequisites

    1. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

  4. Install UDDI 3 Services

    1. Select UDDI Services installation from Microsoft BizTalk 2010 setup.

    2. Leave defaults checked except for UDDI Services Database Component.

  5. Configure Microsoft UDDI Services 3

    1. Select custom configuration.

    2. UDDI Services Web Application

      1. Select the SQL Server instance where you installed the UDDI database (use SQL Server #1).

      2. Type in the credentials for the UDDI service account.

    3. Configure UDDI roles

      1. Open UDDI Services Management Console.

      2. Right-click on the UDDI node and click on Properties.

      3. Select the Roles tab.

      4. Pick the domain BizTalk Server Administrators group for the 4 items.

  6. Publish ESB Toolkit endpoints in UDDI

    1. Go to the ESB Toolkit 2.1 installation folder.

    2. Inside of the bin subfolder, open the Microsoft.Practices.ESB.UDDIPublisher.exe.config file.

    3. Replace every appearance of http://localhost/uddi with the correct URL to your UDDI services installation (only if you changed the URL for UDDI web application).

    4. Hold shift key and right-click on the Microsoft.Practices.ESB.UDDIPublisher.exe file.

    5. Click on Run as different user and when asked for credentials type in the ESB Service account credentials.

    6. When asked for UDDI authentication usage, press Enter.

  7. Prepare ESB Portal installation

    1. Create ESB Portal, ESB UDDI Publisher Service and ESB Alert Service setups

      1. Inside the Development computer follow these steps:

        1. Extract ESBSource.zip (found in Microsoft BizTalk ESB Toolkit 2.1 installation folder) to a new folder.

        2. Remove the read-only flag for the folder, its subfolders and files.

        3. Inside this folder, go to the Keys folder and create a Microsoft.Practices.ESB.snk file, by following the instructions in the Readme.txt file.

        4. Create ESB Portal Setup

          1. Go to the Source\Samples\Management Portal\ESB.Portal folder and open the ESB.Portal.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the ESB.Portal.Setup project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.Portal.Setup\Debug or Source\Samples\Management Portal\ESB.Portal.Setup\Release and copy the ESB.Portal.msi and Setup.exe that were just created to the IIS Server.

        5. Create ESB UDDI Publisher Service Setup

          1. Go to the Source\Samples\Management Portal\ESB.UDDI.PublisherService folder and open the ESB.UDDI.PublisherService.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the ESB.UDDI.PublisherService.Install project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.UDDI.PublisherService.Install\Debug or Source\Samples\Management Portal\ESB.UDDI.PublisherService.Install\Release and copy the BizTalk ESB UDDI Publishing.msi and Setup.exe that were just created to the IIS Server.

        6. Create ESB Alert Service Setup

          1. Go to the Source\Samples\Management Portal\ESB.AlertService folder and open the ESB.AlertService.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the Setup project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.AlertService.Install\Debug or Source\Samples\Management Portal\ESB.AlertService.Install\Release and copy the BizTalk ESB Exception Notification.msi and Setup.exe that were just created to the IIS Server.

    2. Open Internet Information Services Manager and create a new application pool, named EsbPortalNetworkAppPool and configure it to run under Network Service account.

    3. Copy the Source folder with the keys from the Development computer into the IIS server.

  8. Install ESB Portal Administration database

    1. Inside SQL SERVER #2 follow these steps:

      1. Open SQL Server Management Studio and connect to the server.

      2. Open a new query.

      3. Copy the code from Source\Samples\Management Portal\SQL\ESB.Administration.Database.sql in the new query.

        1. If your BizTalk user groups have custom names, then you need to change them inside this file, find and replace BizTalk Application Users and BizTalk Server Administrators with the custom names.

        2. If you want to change the database default name, replace every instance of ESBAdmin in the query with your custom name.

      4. Run the query, and the ESBAdmin database will be deployed.

  9. Install ESB Portal

    1. Run the ESB Portal setup.exe file you previously built and when asked for the Application Pool, select the EsbPortalNetworkAppPool one. This will create all the required virtual directories for the ESB Management Portal in the website you chose.

  10. Install the ESB Portal Alert Service:

    1. Run the Alert Service setup.exe file you previously built.

    2. When asked, type in the ESB Service account credentials.

  11. Install the ESB UDDI Publisher Service:

    1. Run the UDDI Publisher setup.exe file you previously built.

    2. When asked, type in the ESB Service account credentials.

  12. Configure ESB Portal

    1. Go to the website root folder and find the ESB.Portal folder. Open the web.config file and do the following:

      1. Properly configure the AdminDatabaseServer and EsbExceptionDb connection strings to point to SQL Server #2 and the right database names, for example:

        1. <add name="AdminDatabaseServer" connectionString="Data Source=SQLServer2\InstanceName;Integrated Security=True;Initial Catalog=ESBAdmin;" providerName="System.Data.SqlClient"/>
          
          
        2. <add name="EsbExceptionDb" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
          
      2. Find and replace BizTalk Application Users and BizTalk Server Administrators with the right domain group names in the authorization node.

      3. Find the appearances of http://localhost/ESB.BizTalkOperationsService/Operations.asmx, http://localhost/ESB.ItineraryServices/ProcessItinerary.asmx andhttp://localhost/ESB.ItineraryServices.WCF/ProcessItinerary.svc and replace the localhost part with the name of your BizTalk Server computer.

      4. Find the line with the <identity impersonate="true"/> and include the ESB service account credentials, for example:<identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />

      5. Find the client node and inside of it the endpoint node where the address attribute contains ESB.ItineraryServices.WCF/ProcessItinerary.svc. Replace the final /> of the node with ><identity><userPrincipalName value="DOMAIN\USERNAME"/></identity></endpoint>, configuring the proper domain and username for the ESB service account. For example, the resulting configuration should be:

        <endpoint address="http://BIZTALKSERVER/ESB.ItineraryServices.WCF/ProcessItinerary.svc" binding="wsHttpBinding" bindingConfiguration="WSHttpBinding_ITwoWayAsyncVoid" contract="ProcessRequest" name="WSHttpBinding_ITwoWayAsyncVoid"><identity><userPrincipalName value="DOMAIN\USERNAME" /></identity></endpoint>
        
        
    2. Go to the Admin folder inside the ESB.Portal folder. Open the web.config file and do the following:

      1. Find and replace BizTalk Application Users and BizTalk Server Administrators with the right domain group names in the authorization node.

    3. Go to the ESB.Exceptions.Service folder in the same location. Open the web.config file and do the following:

      1. Properly configure the EsbExceptionDbConnectionString connection string to point to SQL Server #2 and the right database name, for example:

        <add name="EsbExceptionDbConnectionString" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
        
        
    4. Go to the ESB.BAM.Service folder in the same location. Open the web.config file and do the following:

      1. Properly configure the BAMEventSource connection string to point to SQL Server #1 and the right database name for BAM Primary Import, for example:

        <add name="BAMEventSource" connectionString="Data Source=SQLServer1\InstanceName;Initial Catalog=BAMPrimaryImport;Integrated Security=True;" providerName="System.Data.SqlClient"/>
        
        
    5. Go to the ESB.UDDI.Service folder in the same location. Open the web.config file and do the following:

      1. Replace every appearance of http://localhost/uddi with the correct URL to your UDDI services installation (only if you changed the URL for UDDI web application).

      2. Find the line with the <identity impersonate="true"/> and include the ESB service account credentials, for example:

        <identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />
        
        
    6. In Internet Information Services Manager, go to the Authentication configuration for all the ESB.Portal, ESB.Exceptions.Service and ESB.BAM.Service applications, disable Anonymous Authentication and enable Windows Authentication.

    7. In Internet Information Services Manager, go to the Basic settings for the ESB.Exceptions.Service and ESB.BAM.Service, and set the Application pool to EsbPortalNetworkAppPool.

  13. Configure the ESB Portal Alert Service:

    1. Go to the Alert Service installation folder and open BizTalk ESB Exception Notification.exe.config file.

    2. Properly configure the EsbExceptionDb connection string to point to SQL Server #2 and the right database name, for example:

      <add name="EsbExceptionDb" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
      
      
  14. Configure the ESB UDDI Publisher Service:

    1. Go to the UDDI Publisher Service installation folder and open BizTalk ESB UDDI Publishing.exe.config file.

    2. Properly configure the AdminDatabaseServer and EsbExceptionDb connection strings to point to SQL Server #2 and the right database names, for example:

      <add name="AdminDatabaseServer" connectionString="Data Source=SQLServer2\InstanceName;Integrated Security=True;Initial Catalog=ESBAdmin;" providerName="System.Data.SqlClient"/>
      <add name="EsbExceptionDb" connectionString="Data Source=SQLServer2\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
      
      
    3. Find the appearances of http://localhost/ESB.BizTalkOperationsService/Operations.asmx and replace the localhost part with the name of your BizTalk Server computer.

2-Box Installation

Infrastructure Configuration

SERVERS

  • BizTalk & IIS Server (for ESB Portal/UDDI/BAM Portal)

  • SQL Server (for BTS, SSO, UDDI and ESB databases)

ADDITIONAL COMPUTERS

  • Active Directory Server (prerequisite)

  • Development computer (for BTS and ESB development and Portal setup build)

SQL Server Installation Steps

  1. Install SQL Server 2008 R2 Prerequisites

    1. Microsoft .NET Framework 3.5.1

      1. Open Server Manager.

      2. Go to Features Node.

      3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and click Install.

    2. Install SQL Server 2008 R2

      1. Run SQL Server 2008 R2 setup logged in as a domain administrator.

      2. Select Installation and then New Installation or add features to an existing installation.

      3. Press Install to install the setup support files.

      4. Configure the Product Key.

      5. Check Database Engine Services.

      6. Check Analysis Services.

      7. Check Management Tools - Complete.

      8. Select either Default Instance or a Named instance and configure the instance root folder and click Next.

      9. Select the SQL user account to be used in the different services and define server default collation.

      10. Select the authentication mode and add the SQL Server administrator users.

      11. Select the authentication mode and add the Analysis Services administrator users.

      12. Press Install to begin the installation.

      13. Open SQL Server Configuration Manager.

      14. Go to SQL Server Network Configuration node, and select the item corresponding to your server instance.

      15. Enable TCP/IP option by right-clicking and selecting Enable.

      16. Go to SQL Server Services node and restart the instance service.

      17. Right click on SQL Server Browser, go to properties, select the Service tab and change Start Mode to Automatic if it’s not.

      18. Right click on SQL Server Browser and start the service if it’s stopped.

    3. Enable MSDTC on the server

      1. Follow this guide: http://go.microsoft.com/fwlink/?LinkID=198391

    4. Install UDDI 3 Services Prerequisites

      1. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

    5. Install UDDI 3 Services

      1. Select UDDI Services installation from Microsoft BizTalk Server 2010 setup.

      2. Check only UDDI Services Database Component.

    6. Configure Microsoft UDDI Services 3

      1. Select custom configuration.

      2. UDDI Services Database Component

        1. Select the SQL Server instance where you want to install the UDDI database.

        2. Uncheck Require SSL for publication to this UDDI services site.

BizTalk Server Installation Steps

  1. Install Microsoft BizTalk Server 2010 Prerequisites

    1. Install Internet Information Services (IIS) 7.0

      1. Open Server Manager.

      2. Go to Roles Node.

      3. Select Web Server (IIS).

      4. Leave the default checks and additionally check ASP.NET, Windows Authentication and IIS 6 Management Compatibility.

    2. Microsoft .NET Framework 3.5.1 and WCF HTTP Activation

      1. Open Server Manager.

      2. Go to Features Node.

      3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and HTTP Activation inside the WCF Activation node and click Install.

    3. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

    4. Microsoft SQL XML 4.0 with Service Pack 1 (http://go.microsoft.com/fwlink/?LinkID=198388)

    5. Microsoft ADO MD.Net 9.0 (http://go.microsoft.com/fwlink/?LinkID=198389)

    6. Microsoft ADO MD.Net 10.0 (http://go.microsoft.com/fwlink/?LinkID=198388)

    7. Microsoft Office Web Components (http://go.microsoft.com/fwlink/?LinkID=198390)

    8. Microsoft SQL Server Complete Management Tools

      1. Run SQL Server 2008 R2 setup logged in as an administrator.

      2. Select Installation and then New Installation or add features to an existing installation.

      3. Press Install to install the setup support files.

      4. Configure the Product Key.

      5. Check Management Tools - Complete.

      6. Press Install to begin the installation.

  2. Install Microsoft BizTalk Server 2010

    1. Leave default installation components checked.

    2. Check the Project Build Component inside Additional Software and install.

  3. Enable MSDTC on the server

    Follow this guide: http://go.microsoft.com/fwlink/?LinkID=198391

  4. Configure Microsoft BizTalk Server 2010

    1. Run BizTalk Server Configuration logged in as a domain administrator.

    2. Select Custom configuration and click Continue.

    3. SSO

      1. Select Create a new SSO system.

      2. Configure SQL server name for SSO database.

      3. Configure SSO to use the SSO service account.

      4. Configure the domain SSO Administrators and SSO Affiliate Administrators user groups.

      5. Define SSO secret master key and write it down in a secure location.

    4. Group

      1. Configure SQL server name for BizTalk databases.

      2. Configure the domain BizTalk Server Administrators, BizTalk Server Operators and BizTalk Server B2B Operators user groups.

    5. BizTalk Runtime

      1. Leave 32-bit only checkboxes checked.

      2. Configure BizTalk Host to use the BizTalk service account.

      3. Configure BizTalk Isolated Host to use the BizTalk service account.

      4. Configure the domain BizTalk Application Users and BizTalk Isolated Host Users user groups.

    6. Business Rules Engine

      1. Configure SQL server name for Business Rule Engine database.

      2. Configure Rule Engine Update Service to use the BizTalk service account.

    7. BAM Tools

      1. Check Analysis services for BAM Aggregations.

      2. Configure SQL server name for BAM databases.

    8. BAM Alerts (optional)

      1. Configure BAM Notifications Service to use BizTalk service account.

      2. Configure SQL server name for BAM alerts database.

    9. BizTalk EDI/AS2 Runtime (optional)

  5. Configure IIS to enable running .NET 4.0 asmx web services in classic application pool mode

    1. Open IIS Manager, click on the local computer node and then double click on the ISAPI and CGI Restrictions icon.

    2. Make sure that both ASP.NET 4.0 items Restriction value is Allowed. If not, right-click on them and select Allow.

  6. Install Microsoft BizTalk Server 2010 ESB Toolkit Prerequisites

    1. Required

      1. Microsoft Windows SDK 7.1 for Windows 7 and .NET Framework 4 (http://go.microsoft.com/fwlink/?LinkID=199001)

  7. Install Microsoft BizTalk Server 2010 ESB Toolkit

  8. Install the Microsoft.Practices.ESB.CORE64.msi and Microsoft.Practices.ESB.JMS.msi files from the BizTalk ESB Toolkit install folder

  9. In BizTalk Server Administration console, right click on the Applications node inside the BizTalk Server Group node and select Import and MSI File. Select the Microsoft.Practices.ESB.CORE64.msi file in the BizTalk ESB Toolkit install folder to install the Microsoft.Practices.ESB application.

  10. In BizTalk Server Administration console, right click on the Applications node inside the BizTalk Server Group node and select Import and MSI File. Select the Microsoft.Practices.ESB.JMS.msi file in the BizTalk ESB Toolkit install folder to install the Microsoft.Practices.JMS application. Check the Microsoft.Practices.ESB application to add a reference to the Microsoft.Practices.ESB application.

  11. Configure SQL Service account permissions for BAM databases

    1. Inside SQL SERVER follow these steps:

      1. Open SQL Server Management Studio and connect to the SQL Server.

      2. Go to Security node, right click on Logins node and click on New Login.

      3. In Login name, type in the SQL Service account full name.

      4. Go to User Mapping, check Map for the BAMStarSchema database, check db_datareader and click Ok.

  12. Deploy ESB Toolkit BAM tracking definitions

    1. Open a command prompt and go to Microsoft BizTalk Server 2010 installation folder.

    2. Go into the Tracking subfolder.

    3. Type in the following command (replace the ESB install folder path if required):

      Bm.exe deploy-all -DefinitionFile:"C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Itinerary.xml"
      
      
    4. Type in the following command (replace the ESB install folder path if required):

      Bm.exe deploy-all -DefinitionFile:"C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml"
      
      
  13. Configure Microsoft BizTalk Server 2010 ESB Toolkit (open the tool from the Start menu)

    1. Exception Database

      1. Configure SQL server name for Exception Management database.

      2. Select the domain BizTalk Server Administrators user group.

      3. Select the domain BizTalk Application Users user group.

    2. Exception Web Services

      1. Configure Exception Web Services to use the ESB service account.

      2. Select the domain BizTalk Isolated Host Users user group.

    3. Itinerary Database

      1. Configure SQL server name for Itinerary database.

      2. Select the domain BizTalk Isolated Host Users user group.

      3. Select the domain BizTalk Application Users user group.

      4. Select the domain BizTalk Server Administrators user group.

    4. Core Web Services

      1. Configure Core Web Services to use the ESB service account.

      2. Select the domain BizTalk Isolated Host Users user group.

  14. Configure impersonation for BizTalk Operations Service

    1. Find the line with the <identity impersonate="true"/> in the web.config file in the Web\ESB.BizTalkOperationsService and Esb.ResolverService folders inside the ESB Toolkit installation folder.

    2. Include the ESB service account credentials, for example:

      <identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />
      
  15. Assign permissions to esb.config

    1. Go to the ESB Toolkit installation folder.

    2. Select both files, right click over them and go to properties.

    3. Go to the Security tab and click on Edit.

    4. Click on Add and select the BizTalk Service User account.

    5. Click Ok to assign the permissions.

  16. Configure esb.config

    1. Go to the ESB Toolkit installation folder.

    2. Open the esb.config file.

    3. Find the line with <add name="baseUri" value="http://localhost/uddi" /> and change the localhost part to point to the IIS Server.

  17. Configure ESB Exception Send port

    1. Open BizTalk Server Administration Console.

    2. Open the Microsoft.Practices.ESB application and select the Send Ports node.

    3. Double-click on the ALL.Exceptions send port and click on Configure.

    4. Modify the connection string to match the ESB Exception database location.

  18. Restart BizTalk Host Instance

    1. Inside the BizTalk Server Administration Console, go to Platform Settings node.

    2. Click on Host Instances node.

    3. Right-click on the main BizTalk Server host instance and click on Restart.

  19. Prepare ESB Portal prerequisite sample applications

    1. Extract ESBSource.zip (found in Microsoft BizTalk ESB Toolkit 2.1 installation folder) to a new folder.

    2. Remove the read-only flag for the folder, its subfolders and files.

    3. Open a command-line prompt.

    4. Go to the Keys subfolder inside the folder you just extracted.

    5. Run the following command to create a Strong Name Key:

      "%PROGRAMFILES%\ Microsoft SDKs\Windows\v7.1\Bin\sn.exe" -k Microsoft.Practices.ESB.snk
      
  20. Install ESB Portal prerequisite sample applications

    1. Open a command-line prompt.

    2. Run the following commands:

      %WINDIR%\syswow64\windowspowershell\v1.0\powershell.exe Set-ExecutionPolicy unrestricted
      powershell.exe Set-ExecutionPolicy unrestricted
      path %PATH%;%PROGRAMFILES%\Microsoft SDKs\Windows\v7.1\Bin
      
      
    3. Install DynamicResolution sample

      1. In the same command prompt, go to the Source\Samples\DynamicResolution\Install\Scripts folder.

      2. Run the following command and type in the ESB service account credentials: Setup_bin.cmd

      3. Leave the command prompt open.

    4. Install Itinerary sample

      1. In the same command prompt, go to the Source\Samples\Itinerary\Install\Scripts folder.

      2. If you changed the default ESB Itinerary Database name, you need to replace every appearance of ESBItineraryDb with the custom name in the following file: Source\Samples\Itinerary\ItineraryDb\ServerItineraries\CreateSampleItineraries.sql.

      3. Run the following command replacing %SQLSERVER% with the correct server and instance name for the ESB Itinerary Db:

        Setup_bin.cmd %SQLSERVER%
        
      4. Leave the command prompt open.

    5. Install MultipleWebServices sample

      1. In the same command prompt, go to the Source\Samples\MultipleWebServices\Install\Scripts folder.

      2. Run the following command:

        Setup_bin.cmd
        
        
      3. Close the command prompt.

IIS Server Installation Steps

  1. Install Microsoft BizTalk Server 2010 ESB Toolkit Prerequisites

    1. Required

      1. Install Internet Information Services (IIS) 7.0

        1. Open Server Manager.

        2. Go to Roles Node.

        3. Select Web Server (IIS).

        4. Leave the default checks and additionally check ASP.NET, Windows Authentication and IIS 6 Management Compatibility.

      2. Microsoft .NET Framework 3.5.1

        1. Open Server Manager.

        2. Go to Features Node.

        3. Click Add Features, inside Microsoft .NET Framework 3.5.1 Features, select Microsoft .NET Framework 3.5.1 node and click Install.

      3. Microsoft Chart Controls for Microsoft .NET Framework 3.5 (http://go.microsoft.com/fwlink/?LinkID=185952)

  2. Install Microsoft BizTalk Server 2010 ESB Toolkit

  3. Install UDDI 3 Services Prerequisites

    1. Microsoft .NET Framework 4.0 (http://go.microsoft.com/fwlink/?LinkID=198951)

  4. Install UDDI 3 Services

    1. Select UDDI Services installation from Microsoft BizTalk 2010 setup.

    2. Leave defaults checked except for UDDI Services Database Component.

  5. Configure Microsoft UDDI Services 3

    1. Select custom configuration.

    2. UDDI Services Web Application

      1. Select the SQL Server instance where you installed the UDDI database .

      2. Type in the credentials for the UDDI service account.

    3. Configure UDDI roles

      1. Open UDDI Services Management Console.

      2. Right-click on the UDDI node and click on Properties.

      3. Select the Roles tab.

      4. Pick the domain BizTalk Server Administrators group for the 4 items.

  6. Publish ESB Toolkit endpoints in UDDI

    1. Go to the ESB Toolkit 2.1 installation folder.

    2. Inside of the bin subfolder, open the Microsoft.Practices.ESB.UDDIPublisher.exe.config file.

    3. Replace every appearance of http://localhost/uddi with the correct URL to your UDDI services installation (only if you changed the URL for UDDI web application).

    4. Hold shift key and right-click on the Microsoft.Practices.ESB.UDDIPublisher.exe file.

    5. Click on Run as different user and when asked for credentials type in the ESB Service account credentials.

    6. When asked for UDDI authentication usage, press Enter.

  7. Prepare ESB Portal installation

    1. Create ESB Portal, ESB UDDI Publisher Service and ESB Alert Service setups

      1. Inside the Development computer follow these steps:

        1. Extract ESBSource.zip (found in Microsoft BizTalk ESB Toolkit 2.1 installation folder) to a new folder.

        2. Remove the read-only flag for the folder, its subfolders and files.

        3. Inside this folder, go to the Keys folder and create a Microsoft.Practices.ESB.snk file, by following the instructions in the Readme.txt file.

        4. Create ESB Portal Setup

          1. Go to the Source\Samples\Management Portal\ESB.Portal folder and open the ESB.Portal.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the ESB.Portal.Setup project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.Portal.Setup\Debug or Source\Samples\Management Portal\ESB.Portal.Setup\Release and copy the ESB.Portal.msi and Setup.exe that were just created to the IIS Server.

        5. Create ESB UDDI Publisher Service Setup

          1. Go to the Source\Samples\Management Portal\ESB.UDDI.PublisherService folder and open the ESB.UDDI.PublisherService.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the ESB.UDDI.PublisherService.Install project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.UDDI.PublisherService.Install\Debug or Source\Samples\Management Portal\ESB.UDDI.PublisherService.Install\Release and copy the BizTalk ESB UDDI Publishing.msi and Setup.exe that were just created to the IIS Server.

        6. Create ESB Alert Service Setup

          1. Go to the Source\Samples\Management Portal\ESB.AlertService folder and open the ESB.AlertService.sln solution file.

          2. Select Debug/Release in the solution configuration to choose the type of installation file to build.

          3. Right click on the Setup project, and click on Rebuild.

          4. Go to the Source\Samples\Management Portal\ESB.AlertService.Install\Debug or Source\Samples\Management Portal\ESB.AlertService.Install\Release and copy the BizTalk ESB Exception Notification.msi and Setup.exe that were just created to the IIS Server.

    2. Open Internet Information Services Manager and create a new application pool, named EsbPortalNetworkAppPool and configure it to run under Network Service account.

    3. Copy the Source folder with the keys from the Development computer into the IIS server.

  8. Install ESB Portal Administration database

    1. Inside the SQL SERVER, follow these steps:

      1. Open SQL Server Management Studio and connect to the server.

      2. Open a new query.

      3. Copy the code from Source\Samples\Management Portal\SQL\ESB.Administration.Database.sql in the new query.

        1. If your BizTalk user groups have custom names, then you need to change them inside this file, find and replace BizTalk Application Users and BizTalk Server Administrators with the custom names.

        2. If you want to change the database default name, replace every instance of ESBAdmin in the query with your custom name.

      4. Run the query, and the ESBAdmin database will be deployed.

  9. Install ESB Portal

    1. Run the ESB Portal setup.exe file you previously built and when asked for the Application Pool, select the EsbPortalNetworkAppPool one. This will create all the required virtual directories for the ESB Management Portal in the website you chose.

  10. Install the ESB Portal Alert Service:

    1. Run the Alert Service setup.exe file you previously built.

    2. When asked, type in the ESB Service account credentials.

  11. Install the ESB UDDI Publisher Service:

    1. Run the UDDI Publisher setup.exe file you previously built.

    2. When asked, type in the ESB Service account credentials.

  12. Configure ESB Portal

    1. Go to the website root folder and find the ESB.Portal folder. Open the web.config file and do the following:

      1. Properly configure the AdminDatabaseServer and EsbExceptionDb connection strings to point to SQL Server and the right database names, for example:

        1. <add name="AdminDatabaseServer" connectionString="Data Source=SQLServer\InstanceName;Integrated Security=True;Initial Catalog=ESBAdmin;" providerName="System.Data.SqlClient"/>
          
          
        2. <add name="EsbExceptionDb" connectionString="Data Source=SQLServer\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
          
      2. Find and replace BizTalk Application Users and BizTalk Server Administrators with the right domain group names in the authorization node.

      3. Find the appearances of http://localhost/ESB.BizTalkOperationsService/Operations.asmx, http://localhost/ESB.ItineraryServices/ProcessItinerary.asmx andhttp://localhost/ESB.ItineraryServices.WCF/ProcessItinerary.svc and replace the localhost part with the name of your BizTalk Server computer.

      4. Find the line with the <identity impersonate="true"/> and include the ESB service account credentials, for example:<identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />

      5. Find the client node and inside of it the endpoint node where the address attribute contains ESB.ItineraryServices.WCF/ProcessItinerary.svc. Replace the final /> of the node with ><identity><userPrincipalName value="DOMAIN\USERNAME"/></identity></endpoint>, configuring the proper domain and username for the ESB service account. For example, the resulting configuration should be:

        <endpoint address="http://BIZTALKSERVER/ESB.ItineraryServices.WCF/ProcessItinerary.svc" binding="wsHttpBinding" bindingConfiguration="WSHttpBinding_ITwoWayAsyncVoid" contract="ProcessRequest" name="WSHttpBinding_ITwoWayAsyncVoid"><identity><userPrincipalName value="DOMAIN\USERNAME" /></identity></endpoint>
        
        
    2. Go to the Admin folder inside the ESB.Portal folder. Open the web.config file and do the following:

      1. Find and replace BizTalk Application Users and BizTalk Server Administrators with the right domain group names in the authorization node.

    3. Go to the ESB.Exceptions.Service folder in the same location. Open the web.config file and do the following:

      1. Properly configure the EsbExceptionDbConnectionString connection string to point to SQL Server and the right database name, for example:

        <add name="EsbExceptionDbConnectionString" connectionString="Data Source=SQLServer\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
        
        
    4. Go to the ESB.BAM.Service folder in the same location. Open the web.config file and do the following:

      1. Properly configure the BAMEventSource connection string to point to SQL Server and the right database name for BAM Primary Import, for example:

        <add name="BAMEventSource" connectionString="Data Source=SQLServer\InstanceName;Initial Catalog=BAMPrimaryImport;Integrated Security=True;" providerName="System.Data.SqlClient"/>
        
        
    5. Go to the ESB.UDDI.Service folder in the same location. Open the web.config file and do the following:

      1. Replace every appearance of http://localhost/uddi with the correct URL to your UDDI services installation (only if you changed the URL for UDDI web application).

      2. Find the line with the <identity impersonate="true"/> and include the ESB service account credentials, for example:

        <identity impersonate="true" userName="DOMAIN\USERNAME" password="PASSWORD" />
        
        
    6. In Internet Information Services Manager, go to the Authentication configuration for all the ESB.Portal, ESB.Exceptions.Service and ESB.BAM.Service applications, disable Anonymous Authentication and enable Windows Authentication.

    7. In Internet Information Services Manager, go to the Basic settings for the ESB.Exceptions.Service and ESB.BAM.Service, and set the Application pool to EsbPortalNetworkAppPool.

  13. Configure the ESB Portal Alert Service:

    1. Go to the Alert Service installation folder and open BizTalk ESB Exception Notification.exe.config file.

    2. Properly configure the EsbExceptionDb connection string to point to SQL Server and the right database name, for example:

      <add name="EsbExceptionDb" connectionString="Data Source=SQLServer\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
      
      
  14. Configure the ESB UDDI Publisher Service:

    1. Go to the UDDI Publisher Service installation folder and open BizTalk ESB UDDI Publishing.exe.config file.

    2. Properly configure the AdminDatabaseServer and EsbExceptionDb connection strings to point to SQL Server and the right database names, for example:

      <add name="AdminDatabaseServer" connectionString="Data Source=SQLServer\InstanceName;Integrated Security=True;Initial Catalog=ESBAdmin;" providerName="System.Data.SqlClient"/>
      <add name="EsbExceptionDb" connectionString="Data Source=SQLServer\InstanceName;Initial Catalog=EsbExceptionDb;Integrated Security=True;" providerName="System.Data.SqlClient"/>
      
      
    3. Find the appearances of http://localhost/ESB.BizTalkOperationsService/Operations.asmx and replace the localhost part with the name of your BizTalk Server computer.

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