Pre-requisite for ESB 2.1
· Microsoft Windows 2008 Server SP1/ SP2
· .NET framework 3.5 SP1
· IIS 7.0
· Microsoft SQL Server 2008
· Microsoft BizTalk Server 2009/2010
· Visual Studio 2008 SP1/ 2010
· Microsoft Chart Controls for .NET Framework 3.5 (This would be used by ESB Portal)
· Microsoft Enterprise Library 4.1
Note: If your machine has Microsoft Enterprise Library 5.0 installed it would be advisable to un-install 5.0 and install Microsoft Enterprise Library 4.1 (http://www.microsoft.com/download/en/details.aspx?id=6228) as the ESB solution targets 4.1 version.
1) Install Microsoft ESB Toolkit 2.1 (http://www.microsoft.com/download/en/details.aspx?id=11847)
This will install the tools and samples.
2) Navigate to Start à All Programs à Microsoft BizTalk Server 2010 ESB Toolkit
Click Install Itinerary designer extension to register the itinerary designer extension in Visual Studio 2010
3) Verify whether the installation was successful by;
Open Visual Studio 2010 and check whether you see an option to create an ESB itinerary
4) Open BizTalk admin console and;
· Import Microsoft.Practices.ESB.CORE64.msi into the Applications node (remember to select Overwrite resources). Continue the installer to install the assemblies into GAC.
If you get an error like;
There is a problem with this Window Installer package. A program required for this install to complete could not be run. Contact your support personnel or package vendor.
This implies there is a problem GACing the assemblies. At this point all assemblies except Microsoft.Practices.ESB.ExceptionHandling.PipelineComponents.dll are in the GAC.
o To GAC the above, navigate to the folder where the installer had dumped all the assemblies which were to be GACed. Default location is "C:\Program Files (x86)\Generated by BizTalk".
o Navigate to C:\Program Files (x86)\Generated by BizTalk\Microsoft.Practices.ESB\<GUID Folder>\ and extract ITEM~14. This will have Microsoft.Practices.ESB.ExceptionHandling.PipelineComponents.dll which can be dragged to the GAC.
· Clear "C:\Program Files (x86)\Generated by BizTalk" folder
· Import Microsoft.Practices.ESB.ExceptionHandling64 into the Applications node (remember to select Overwrite resources). Continue the installer to install the assemblies into GAC.
If you get an error like;
There is a problem with this Window Installer package. A program required for this install to complete could not be run. Contact your support personnel or package vendor.
Ignore this error as all required assemblies have been GACed.
· Clear "C:\Program Files (x86)\Generated by BizTalk" folder
· Import Microsoft.Practices.ESB.JMS into the Applications node (remember to select Overwrite resources). Continue the installer to install the assemblies into GAC.
If you get an error like;
There is a problem with this Window Installer package. A program required for this install to complete could not be run. Contact your support personnel or package vendor.
This implies there is a problem GACing the assemblies. At this point all assemblies except Microsoft.Practices.ESB.JMS.PipelineComponents.dll are in the GAC.
o To GAC the above, navigate to the folder where the installer had dumped all the assemblies which were to be GACed. Default location is "C:\Program Files (x86)\Generated by BizTalk".
o Navigate to C:\Program Files (x86)\Generated by BizTalk\ Microsoft.Practices.JMS\<GUID Folder>\ and extract ITEM~0. This will have Microsoft.Practices.ESB.JMS.PipelineComponents.dll which can be dragged to the GAC.
· Clear "C:\Program Files (x86)\Generated by BizTalk" folder
· For safety place the pipeline components assemblies i.e.
o Microsoft.Practices.ESB.JMS.PipelineComponents
o Microsoft.Practices.ESB.ExceptionHandling.PipelineComponents
; Into "C:\Program Files\Microsoft BizTalk Server 2010\Pipeline Components"
5) Navigate to "C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1" and extract ESBSource.zip file. This would create the ESBSource solutions folder with a Keys subfolder having the assembly key files and Source subfolder with the actual ESB solution
6) We need to create an assembly key file to be used by the ESB solution. To do that open Visual Studio command prompt and type in;
sn -k "C:\Program File\Microsoft BizTalk ESB Toolkit 2.1\ESBSource\Keys\Microsoft.Practices.ESB.snk"
7) Navigate to "C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\ESBSource\Source\Samples\Management Portal\ESB.Portal"
Open ESB.Portal solution and re-build the solution.
Do NOT proceed unless the solution builds successfully. You may have to fix some references to get the solution in a compiled state.
8) Next we have to change the script execution policy as we are going to run some scripts to install the portal solution.
Navigate to Start à All Programs à Accessories à Windows PowerShell and click on Windows PowerShell.
· At the prompt type get-executionpolicy which will display the current execution policy.
· If it says Restricted we have to change it to Unrestricted as follows:
o At the prompt type in set-executionpolicy Unrestricted
Since the portal solution scripts may target any version of Windows PowerShell we have to set the execution policies for both the x64 and x86 versions. So,
Navigate to Start à All Programs à Accessories à Windows PowerShell and click on Windows PowerShell (x86)
· At the prompt type in get-executionpolicy which will display the current execution policy.
· If it says Restricted we have to change it to Unrestricted as follows:
o At the prompt type in set-executionpolicy Unrestricted
9) Navigate to "C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\ESBSource\Source\Samples\Management Portal\Install\Scripts" and double click on Management_Install.cmd
This would install the portal and create all the required virtual directories in the IIS
10) Open IIS and make sure ESB.Portal virtual directory is created under Sites\Default Web Site.
Ensure that it is pointing to the correct folder i.e. "C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\ESBSource\Source\Samples\Management Portal\ESB.Portal"
11) Select ESB.Portal node and in the page on the right hand side double click Authentication.
Ensure that Windows Authentication is Enabled.
12) Navigate to "C:\Program Files\Microsoft BizTalk ESB Toolkit 2.0\Bin\" and double click on ESBConfigurationTool.exe.
Note: ESBConfigurationTool works in a linear way i.e. Exception Management, Database is configured first followed by Exception Management, Exception Web Services followed by ESB Core Components, Itinerary Database followed by ESB Core Components, Core Web Services and finally the Configuration. Also each of the features have to be configured separately i.e. Hit "Apply Configuration" after each step rather than trying to configure all features in one go.
· Open ESB Configuration à Exception Management à Database
o Check Enable Exception Management Database and specify the Database server name
o Click on Apply Configuration
· Open ESB Configuration à Exception Management à Exception Web Services
o Check Enable Exception Services
o Provide the user name, password details and Click on Apply Configuration
· Open ESB Configuration à ESB Core Components à Itinerary Database
o Check Itinerary Database and specify the Database server name
o Click on Apply Configuration
· Open ESB Configuration à ESB Core Components à Core Web Services
o Check Enable Core Services
o Provide the user name, password details and Click on Apply Configuration
· Open ESB Configuration à Configuration
o Make sure File Configuration Source is selected. (This option will save all the settings to ESB.config file)
13) Add all portal user names to BizTalk Isolated Host Users, BizTalk Application Users, SSO Administrator and SSO Affiliate Administrator groups.
14) Deploy the portal bam tables. Open a command prompt and navigate to "C:\Program Files\Microsoft BizTalk Server 2010\Tracking". Run the following commands to deploy the bam tables:
· bm.exe deploy-all -DefinitionFile:"C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Itinerary.xml"
· bm.exe deploy-all -DefinitionFile:"C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml"
If you get an error like;
Deploying View... ERROR: The BAM deployment failed. The BAM Star Schema database has not been configured. Run bm.exe setup-databases to configure the database.
It was because the BAM Star Schema and analysis services have not yet been configured.
o Open Run and type in Configuration or alternatively open the BizTalk Server Configuration
o Click on Bam Tools in the BizTalk Server Configuration window.
o Check Enable Analysis Service for BAM aggregations and specify an appropriate Server Name for Bam Analysis Database (optional) and BAM Star Schema Database
o Click on Apply Configuration to create the databases.
o Before running the bm deploy command again we have to grant ourselves access to the newly created BAM Star Schema.
Open SQL Management Studio à Database Instance à Security à Logins and double click on <Your Installation ID>.
In the Login properties window select User Mapping node and check on BAMStarSchema.
In the Database role membership pane for BAMStarSchema check public, db_datareader, db_datawriter and Click OK
o Run bm.exe deploy-all -DefinitionFile:"C:\Program Files\Microsoft BizTalk ESB Toolkit 2.1\Bam\Microsoft.BizTalk.ESB.BAM.Exceptions.xml" again
15) Exception management portal relies on ExceptionService.svc WCF service. IIS 7.0 installation does not have a script map for .svc files and hence they have to be registered explicitly as follows:
Open a command prompt and navigate to "C:\Windows\Microsoft.NET\Framework\v3.0\Windows Communication Foundation"
Run the following command: ServiceModelReg.exe -r –y
16) Restore the execution policy to Restricted i.e.
Navigate to Start à All Programs à Accessories à Windows PowerShell and click on Windows PowerShell
Run set-executionpolicy Restricted
Navigate to Start à All Programs à Accessories à Windows PowerShell and click on Windows PowerShell (x86)
Navigate to Start à All Programs à Accessories à Windows PowerShell and click on Windows PowerShell (x86)
Run set-executionpolicy Restricted
17) Restart IIS and SQL Server.
18) Verify whether ESB 2.1 installation-configuration was successful by opening a browser with the following url:
Other Errors
1) On opening the ESB Management portal if you get an error message pointing to the event viewer and the event viewer message says "assembly Microsoft.Practices.ESB.Portal.Global not found", this means that the ESB portal solution build has been un-successful i.e. Step (11) has to be re-visited
2) On opening the ESB Management portal you get an error message pointing to the event viewer and the event viewer message says "could not load type System.ServiceModel.Activation.HttpModule", this means that because of the order of the software installation on your machine i.e. IIS installed after .Net framework the .net version has not been registered with IIS.
To fix this problem;
Open a command prompt, navigate to "C:\Windows\Microsoft.NET\Framework\v4.0.30319 (or the version installed on your machine)" and run the following command
aspnet_regiis.exe –iru
3) If there are still any problems with the installation try the following links
http://dgoins.wordpress.com/2010/05/01/esb-toolkit-management-portal-installation-notes-from-the-field-2/
http://dgoins.wordpress.com/2010/05/01/esb-toolkit-management-portal-installation-notes-from-the-field-2/