Tags

, ,

Installing the BizTalk ESB Toolkit 2.1

Follow this simple step-by-step guide to get the BizTalk ESB Toolkit 2.1 up and running.

  1. Browse to http://www.microsoft.com/en-us/download/details.aspx?id=11847 and click the download button for the “BizTalk ESB Toolkit 2.1-x64.msi” file. The setup wizard opens up and guides you through the install process.
  2. Be sure to select the Samples when you intend to install the ESB Management Portal.ESB Installation Wizard

    ESB Installation Wizard

  3. Accept the setup wizard’s remaining defaults and click the Install button.
  4. Navigate to the root folder of the ESB Toolkit install located at C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1 and open “Installation Guide.htm”.  “Installation Guide.htm” provides step by step instructions for installing and configuring the ESB Toolkit.

Installation Prerequisites

  1. Review the required and optional install prerequisites. Ensure they are all successfully installed before proceeding.
  2. Pay special attention to the IIS 6 extensions that must be installed.  Browse to the Administrative Tools and ensure “Internet Information Services (IIS) 6.0 Manager” is listed next to “Internet Information Services (IIS) Manager” (when sorted alphabetically).  If so, skip the following top-level task.  If “Internet Information Services (IIS) 6.0 Manager” is not installed, perform the following sub-tasks.
    1. Open Server Manager.
    2. Click on the Roles item in the left hand navigation.
    3. Scroll down to the “Role Services” section in the content view and click the “Add Role Services” hyperlink.IIS Roles

      IIS Roles

    4. Scroll down and select the “IIS 6 Management Compatibility” item.
    5. Click the Next button and then click the Install button.
    6. Click the Close button after the successful installation of the IIS 6 extensions.
  3. Pay special attention to SQL Server Analysis Services and ensure it is installed for BAM Aggregations support required by the ESB Management Portal. If Analysis Services was not already installed, then after installing, be sure to complete the following tasks for BAM Aggregations support.
    1. Open the BizTalk Server 2010 Configuration utility.
    2. Click on the “BAM Tools” item on the left hand navigation.BizTalk BAM Configuration Before

      BizTalk BAM Configuration Before

    3. Click to check the “Enable Analysis Services for BAM aggregations” checkbox. Notice the following 2 data store records are added in the main content data grid:  BAM Analysis Database and BAM Star Schema Database.BizTalk BAM Configuration After

      BizTalk BAM Configuration After

    4. Enter the correct analysis server instance name for the BAM Analysis Database record’s “Server Name” field.
    5. Enter the correct database server instance name for BAM Star Schema Database record’s “Server Name” field.
    6. Click the “Apply Configuration” button on the toolbar to complete the configuration.
    7. Click Next and accept the defaults, click the Finish button and close the BizTalk Server Configuration utility.
  4. Pay special attention to Microsoft Chart Controls for .NET Framework 3.5 and ensure it is installed. If not, perform the following sub-tasks to install it.
    1. Browse to http://www.microsoft.com/en-us/download/details.aspx?id=14422 and click the Download button for the MSChart.exe file.
    2. Execute MSChart.exe.
    3. Click Next and accept the defaults until the install completes successfully.
    4. Click the Finish button to close the install wizard.
  5. Pay special attention to the Visual Studio 2010 Software Development Kit and ensure it is installed if the Itinerary Designer is required.
    1. Browse to http://www.microsoft.com/en-us/download/details.aspx?id=2680 and click the Download button for the VsSDK_sfx.exe file.
    2. Execute VsSDK_sfx.exe.
  6. Pay special attention to the Windows SDK for Windows 2008 and ensure it is installed.  If not, perform the following sub-tasks to install it.
    1. Browse to http://www.microsoft.com/en-us/download/details.aspx?id=11310 and click the Download button for the Setup.exe file.
    2. Execute Setup.exe.
    3. Click Next and accept the defaults except for the “Installation Options” screen.
    4. Deselect all options except for “Developer Tools”. In the future, it will be good to identify exactly which features of the Windows SDK are required for the ESB Management Portal.Windows SDK

      Windows SDK

    5. Click the Finish button after the SDK is successfully installed to close the install wizard.
  7. Pay special attention to Microsoft UDDI Services 3 and ensure it is installed if UDDI services are required.  If not, perform the following sub-tasks to install it.
    1. Browse to http://www.microsoft.com/en-us/download/details.aspx?id=10030 and click the Download button for the BizTalk2009_UDDIServices30_EN.exe file.
    2. Execute BizTalk2009_UDDIServices30_EN.exe.
    3. Extract the files to a suitable location, such as C:\Program Files (x86)\Microsoft UDDI Services 3.
    4. By default Setup.exe will automatically execute to display the install wizard.
    5. Click the “Install Microsoft UDDI Services on this computer” hyperlink.
    6. Click Next accepting the defaults and click the Install button.
    7. Click the Finish button to close the install wizard.
    8. The Microsoft UDDI Services Configuration wizard is displayed.
    9. Choose the “Basic Configuration” option, enter the required information and click the Configure button.

Installing and Configuring the Core

  1. Install the ESB Toolkit
    1. Import the MSI located at “C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Microsoft.Practices.ESB.CORE64.msi” using the BizTalk Administration console.
    2. Open the BizTalk Server Administration console.
    3. Right-click on the Applications node, in the left hand navigation, and select Import ->  “MSI file …”BizTalk Applications

      BizTalk Applications

    4. Click the ellipses button and select the MSI file to import, located at “C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Microsoft.Practices.ESB.CORE64.msi”.BizTalk Application Import Wizard Begin

      BizTalk Application Import Wizard Begin

    5. Click Next accepting the defaults and click the Import button.
    6. Install the MSI by enabling the “Run the Application Installation Wizard …” checkbox and clicking the Finish button. Or simply double-click the install located at “C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Microsoft.Practices.ESB.CORE64.msi”.BizTalk Application Import Wizard Complete

      BizTalk Application Import Wizard Complete

    7. Click Next accepting the defaults and click the Close button.
  2. Configure the BizTalk ESB Toolkit.
    1. Double click the ESBConfigurationTool.exe located in “C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bin”.
    2. Expand the left hand navigation items as seen in the image below.ESB Confiuration Tool - Initial

      ESB Configuration Tool – Initial

    3. Click on the Database navigation node located under the “Exception Management” navigation node.ESB Configuration Tool - Exception Management Database

      ESB Configuration Tool – Exception Management Database

    4. Enable the “Enable Exception Management Database” checkbox and enter valid information into the text boxes listed below the checkbox.
    5. Click the “Apply Configuration” button.
    6. Click the “Exception Web Services” navigation node under the “Exception Management” navigation node.ESB Configuration Tool - Exception Web Services

      ESB Configuration Tool – Exception Web Services

    7. Enable the “Enable Exception Services” checkbox and enter valid information into the text boxes listed below the checkbox.
    8. Click the “Apply Configuration” button.
    9. Click the “Itinerary Database” navigation node under the “ESB Core Components” navigation node.ESB Configuration Tool - Itinerary Database

      ESB Configuration Tool – Itinerary Database

    10. Enable the “Itinerary Database” checkbox and enter valid information into the text boxes listed below the checkbox.
    11. Click the “Apply Configuration” button.
    12. Click the “Core Web Services” navigation node under the “ESB Core Components” navigation node.ESB Configuration Tool - Core Web Services

      ESB Configuration Tool – Core Web Services

    13. Enable the “Enable Core Services” checkbox and enter valid information into the text boxes listed below the checkbox.
    14. Click the “Apply Configuration” button.
    15. Click the Configuration navigation node.B Configuration Tool - SSO Configuration

      ESB Configuration Tool – SSO Configuration

    16. Select the “File Configuration Source” radio button if the BizTalk ESB Toolkit is being installed on a BizTalk Group with a single application server.  Select the “SSO Configuration Source” radio button if the BizTalk ESB Toolkit is being installed on a BizTalk Group with multiple application servers.
      1. Enter valid information into the text boxes listed below the radio buttons.

Extending the Core

  1.  Install BAM Definitions
    1. Open a command prompt and change the directory to “C:\Program Files (x86)\Microsoft BizTalk Server 2010\Tracking”.
    2. Execute the following command to install the itinerary activities:
      1. Bm.exe deploy-all -DefinitionFile:”C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Itinerary.xml”
    3. Execute the following command to install the exception activities:
      1. Bm.exe deploy-all -DefinitionFile:”C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml”
  2. Install the ESB Management Portal
    1. Unzip “C:\Program Files (x86)\Microsoft BizTalk ESB Toolkit 2.1\ESBSource.zip” to C:\Projects\Microsoft.Practices.ESB.  Evidently, the management portal code is dependent on the C:\Projects\Microsoft.Practices.ESB location but there is a registry entry where this can be changed.  Ensure the Keys and Source folders are directly under the Microsoft.Practices.ESB folder.
    2. Remove the read-only attribute on the C:\Projects\Microsoft.Practices.ESB folder so the samples install correctly.
    3. Add a signing key, named Microsoft.Practices.ESB.snk, to “C:\Projects\Microsoft.Practices.ESB\Keys”.
    4. To turn on unrestricted acess for PowerShell, execute the following command using the PowerShell 32-bit and 64-bit consoles:
      1. set-executionpolicy unrestricted
    5. Open a command prompt using “Run as administrator”
      1. To ensure the WCF script maps are registered, execute the following command:
        1. %WINDIR%\Microsoft.NET\Framework\v4.0.30319\ServiceModelReg.exe -r
      2. Execute the Management_Install.cmd located in “C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\Install\Scripts”.
    6. Open SQL Server Management Studio and connect to the SQL Server instance that hosts the ESB databases. Open the SQL script “ESB.Administration Database.sql” from the “Source\Samples\Management Portal\SQL” folder into a new Query window and execute it to create the EsbAdmin database.
    7. Open and edit the web.config located at “C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\ESB.Portal”.
      1. Set the customErrors mode attribute to “Off”.
      2. If you’re using a database server instance other than the default instance of the server hosting the ESB portal, update the AdminDatabaseServer connectionString to use the correct database server instance.
    8. Update the following web.config files, located in each of the dependent services, to use the correct database server instance.
      1. C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\ESB.Exceptions.Service\ESB.Exceptions.Service\web.config
      2. C:\Projects\Microsoft.Practices.ESB\Source\Samples\Management Portal\ESB.BAM.Service\ESB.BAM.Service\ESB.BAM.Service\web.config
    9. Ensure the default service file (svc or asmx) can be successfully accessed/browsed for the following 3 services:
      1. ESB.BAM.Service
      2. ESB.BizTalkOperationsService
      3. ESB.Exceptions.Service
    10. Open the ESB.Portal solution and ensure it builds successfully.
    11. Attempt to browse to default.aspx located in the web application’s root.
      1. Congratulations assuming the page loads successfully.
      2. If an exception is returned, use the information to debug the ESB.Portal solution code and identify the cause.  The portal should load successfully as long as the 3 services above are browsable, the database connection strings are correct and the portal solution builds.

      Quote: http://connecsys.wordpress.com/2013/01/09/installing-the-biztalk-esb-toolkit-2-1-2/