Contents
Upgrading to BizTalk Server 2013 from BizTalk Server 2010/2009
How to Use this Document
Introduction
Planning Your Upgrade
Supported Upgrade Paths
Considerations for Upgrading to BizTalk Server 2013
Before the Upgrade
After the Upgrade
Considerations for BAM
Considerations for Enterprise Single Sign-On (ESSO)
Upgrading from an Earlier Version of Enterprise Single Sign-on
Upgrade using the Enterprise Single Sign-On standalone setup
Considerations for Upgrading in a Multicomputer Environment
General Considerations When Upgrading to BizTalk Server 2013
Preparing Your Computer for Upgrade
Install Critical Windows Updates
SQL Server Upgrades
Install Visual Studio Side-by-Side
Performing the Upgrade
Stop BizTalk and Windows Services
Back Up Databases for BizTalk Server and SQL Server
Upgrade to BizTalk Server 2013
Verify Your Installation
Appendix A: Customer Experience Improvement Program
Customer Experience Improvement Program
Options
Appendix B: Known Issues
Upgrading to BizTalk Server 2013 from BizTalk Server 2010/2009
How to Use this Document
This guide is divided into the following five sections:
Introduction provides an overview of the upgrade process and tells what information you may need during the upgrade process.
Considerations for upgrading to BizTalk Server 2013 provides a checklist to follow before and after you upgrade to BizTalk Server 2013.
Preparing your computer for upgrade walks you through installing and configuring all prerequisite software, and setting necessary permissions.
Performing the upgrade walks you through BizTalk Server 2013 upgrade. The section includes procedures for determining whether the upgrade was successful.
Appendices
A. Customer Experience Improvement Program in BizTalk Server 2013
B. Known issues
Introduction
This document provides an overview of the BizTalk Server 2013 upgrade process, considerations for the upgrade, and step-by-step instructions for upgrading BizTalk Server2010/2009 to BizTalk Server 2013.
We recommend that you read this entire document before beginning the upgrade. BizTalk Server connects many disparate components both internal and external to your enterprise so information can flow smoothly and securely in many directions. Most real-world deployment scenarios extend much farther to include multiple servers and eventually clusters of both physical and virtual computers.
No two deployments of BizTalk Server are the same. Before you upgrade, gather information on your enterprise needs, and discuss the scope of your deployment with the IT Professionals, System Administrators, and Developers who use BizTalk Server. By studying this upgrade guide and determining the specific needs of your enterprise, you are creating your own deployment roadmap.
You can also download and install the BizTalk Server Best Practices Analyzer ( The Best Practices Analyzer (BPA) examines a BizTalk Server deployment and generates a list of best practices. BPA performs configuration-level verification, by reading and reporting only, and uses the gathered data to determine whether best practices are being followed.
Planning Your Upgrade
The following is a high-level glimpse of the upgrade process. Each of the steps listed must be run in the order shown.
Preparing your computer for upgrade
The following is a list of things to consider when you upgrade to BizTalk Server 2013:
Operating systems upgrade paths
Microsoft SQL Server® upgrade paths
Windows® SharePoint® Services upgrade
Install Microsoft ® Visual Studio ® 2012side-by-side
Install Microsoft Office2013/2010 side-by-side
Install .NET Framework4.5/4.0 side-by-side
Supported Upgrade Paths
The following table lists the supported operating systems that can be upgraded to BizTalk Server 2013. “Yes” means the BizTalk Server version running on that operating system can be upgraded to BizTalk Server 2013. “No” means the BizTalk Server version running on that operating system cannot be upgraded to BizTalk Server 2013. When “No”, the BizTalk environment must be recreated on an operating system supported by BizTalk Server 2013.Hardware and Software Requirements lists the supported operating systems.
Operating Systems / BizTalk Server 2010 / BizTalk Server 2009Windows Server®2008 R2 SP1 / Yes / No
Windows Server2012 / No / No
Windows 8 / No / No
Windows7 SP1 / Yes / No
Windows Vista / Yes / Yes
The following table lists the supported SQL Server versions that can be upgraded to BizTalk Server 2013. The SQL Server hosts the databases used by BizTalk Server. “Yes” means the SQL Server version can be upgraded to BizTalk Server 2013. “No” means the SQL Server version cannot be upgraded to BizTalk Server 2013. When “No”, the BizTalk environment must be recreated on a SQL Server version supported by BizTalk Server 2013.Hardware and Software Requirements lists the supported SQL Server versions.
SQL Server / BizTalk Server2010 / BizTalk Server2009SQL Server 2008 R2 SP1 / Yes / No
SQL Server 2012 / No / No
SQL Server2008 R2 / Yes / Yes
SQL Server2008 / Yes / No
SQL Server2005 / Yes / Yes
The following table lists the supported upgrade path from BizTalk Server 2010 and BizTalk Server 2009 to BizTalk Server 2013. “Yes” means the BizTalk Server 2010 and BizTalk Server 2009 editions can be upgraded to that BizTalk Server 2013 edition. “No” means the BizTalk Server 2010 and BizTalk Server 2009 editions cannot be upgraded to that BizTalk Server 2013 edition. When “No”, the BizTalk environment must be recreated.
BizTalk Server2010/2009 / BizTalk Server 2013 Evaluation Edition / BizTalk Server 2013 Branch Edition / BizTalk Server 2013 Developer Edition / BizTalk Server 2013 Standard Edition / BizTalk Server 2013 Enterprise EditionEvaluation / No / No / No / No / Yes
Branch / No / Yes / No / No / Yes
Developer / No / No / Yes / No / Yes
Standard / No / No / No / Yes / Yes
Enterprise / No / No / No / No / Yes
Considerations for Upgrading to BizTalk Server 2013
Important
Before you upgrade from BizTalk Server 2009 to BizTalk Server 2013, run the Microsoft BizTalk Server Party Migration Tool (Party Migration Tool) to migrate the party-specific data from BizTalk Server 2009 to the new TPM model in BizTalk Server. For more information about the enhanced Trading Partner Management (TPM) provided with BizTalk Server 2013, see Trading Partner Management Using BizTalk Server.
BizTalk Server 2013 upgrade occurs in three phases:
1.Phase one: Setup installs and verifies prerequisites.
2.Phase two: The setup upgrades databases, removes features from the existing version of BizTalk Server, and installs BizTalk Server 2013.
3.Phase three: Setup reconfigures BizTalk Server features.
Before the Upgrade
Before you upgrade to BizTalk Server 2013, consider the following:
Run the Microsoft BizTalk Server Party Migration Tool (Party Migration Tool). If you have parties with Electronic Data Interchange (EDI) data, migrate the party data from the old Trading Partner Management (TPM) model to the new TPM model.
Back up the Windows certificates store. To back up certificates, see importing and exporting certificates for the following operating systems:
Windows 7 and Windows Server 2008 R2: Import a Certificate (
Windows 7 and Windows Server 2008 R2: Export a Certificate (
Windows Server2003 (
Windows Vista (
Windows XP (
Before you perform a platform upgrade, uninstall KB926139-V2\KB926141 - Windows PowerShell 1.0 for Windows Server 2003 and for Windows XP.
After the platform upgrade, enable Microsoft Distributed Transaction Coordinator (MSDTC). For more information, see Post-installation Steps for BizTalk Server 2013 (
After enabling MSDTC, enable Inbound/Outbound DTC rules. Use the following steps to enable DTC rules:
a.Click Start, point to Administrative Tools, and then click Windows Firewall with Advanced Security.
b.In Windows Firewall with Advanced Security, click Inbound Rules.
c.In the Inbound Rules pane, right-click Distributed Transaction Coordinator * (as appropriate), and then click Enable Rule.
d.In Windows Firewall with Advanced Security, click Outbound Rules.
e.In the Outbound Rules pane, right-click Distributed Transaction Coordinator * (as appropriate), and then click Enable Rule.
The Windows SharePoint Services (WSS) adapter has changed in BizTalk Server 2013. If you are using SharePoint 2013, SharePoint Online, or SharePoint 2010, you can use the new Client Side Object Model (CSOM) to connect to SharePoint Services; which is recommended. BizTalk Server 2010 and previous versions use the Server Side Object Model (SSOM) to connect to SharePoint 2010. SharePoint 2007 is not supported with BizTalk Server 2013. The SSOM option is deprecated in BizTalk Server 2013.
If you are using SharePoint 2007 or SharePoint Services 3.0, you may be able to upgrade to a supported SharePoint version. Refer to the following links for SharePoint upgrade options:
Upgrade to SharePoint 2013
Upgrading to SharePoint Server 2010
BAM Alerts has changed in BizTalk Server 2013. If SQL Server is upgraded to SQL Server 2012, SQL Server Database Mail is required. SQL Server Notification Services cannot be used by BAM Alerts on SQL Server 2012. If you are using SQL Server 2008 R2, SQL Server Notification Services are required. The following steps assume you are using SQL Server Notification Services with SQL Server 2008 R2.
Install SQL Server 2005 Notification Services ( on machines that do not have SQL Server 2005 Notification Services installed.
We recommend that you stop BAM Notification Services, such as NS$BAMAlerts.
The user performing the upgrade must be a member of the following user groups or have the equivalent permissions:
Administrators group on the local computer
SQL Server System Administrators group on the SQL Server
BizTalk Server Administrators group
Single Sign-On (SSO) Administrators group
The Single Sign-On Master Secret Server must be running at the time of upgrade.
The SQL Server that hosts the SSO database must be running during the upgrade.
All BAM Data Transformation Services (DTS) packages must be stopped when the upgrade is performed. Otherwise data may be lost or an online analytical processing (OLAP) cube may become corrupted.
The Network Service account must have write access to %windir%\temp.
The BizTalk Server 2013 upgrade process requires the existence of the default host. If the default host instance associated with the SQL Adapter send ports and receive locations is removed, associate the default host to the SQL Adapter before upgrading. After upgrade is complete, you can remove the default host from the list again.
When upgrading from BizTalk Server 2009 Accelerator for HL 7, run the HL72009Patch.msp file from the BizTalk Server 2013 installation media.
User-defined custom bindings that are built with earlier versions of the .NET Framework are not available after you upgrade to BizTalk Server 2013. To use the custom bindings, manually add the custom bindings in the .NET Framework 4.5 machine.config file.
Before you upgrade to BizTalk Server 2013, back up all custom managed configuration files in BizTalk Server2010/2009. BizTalk Server 2013 supports migration of changes only in the btsntsvc.exe.config and bm.exe.config files.
After the Upgrade
After upgrading to BizTalk Server 2013, you may need to do one or more of the following tasks:
In earlier versions of BizTalk Server, the Human Workflow Services feature (HWS) added the BTSHttpReceive.dll extension to BizTalk Server. However, HWS is deprecated in the previous release of BizTalk Server. Therefore, this extension is no longer added. If you need this extension, you must add it manually.
You cannot roll back to BizTalk Server2010/2009.
If the MQSAgent.dll file is installed on a remote WebSphere MQ Server, install a new version of the MQ Agent from BizTalk Server 2013 on the remote WebSphere MQ Server.
If you use the MSMQ adapter, start the Message Queuing service.
The upgrade process preserves the existing user permissions settings on the <DocumentsHome>\Subsystem folder for the EDI Subsystem service. Administrators should evaluate their existing environment to determine the appropriate permissions settings for this folder. For a secure deployment, we recommend that only local administrators (that is, not members of the BizTalk Server Administrators group) be allowed full control and be assigned ownership, and that members of the EDI Subsystem Users group be assigned Read/Write permissions only with no ownership granted to them (as set on the Owner tab of the Advanced Security Settings dialog box).
If you have a custom managed executable file that references Business Rule Engine assembly in BizTalk Server2010/2009, add the following to the application configuration file to run the process in the .NET Framework 2.0.
<?xml version="1.0" encoding="Windows-1252"?>
<configuration>
<startup>
<supportedRuntime version="v2.0.50727" />
</startup>
</configuration>
Run the migrate database command. Use the bm.exe command to migrate your SQL Server databases based on the version of SQL Server you are upgrading from. The following table describes the various SQL Server upgrade scenarios.
Note
If you have a multicomputer installation, upgrade SQL Server on all client and server computers that host the BizTalk Server databases.
Before you run the bm.exe program, back up all of your BizTalk Server 2010/2009 and SQL Server databases and the current settings of all SQL Server Agent jobs used by BizTalk Server. Confirm that SQL Server2005 Notification Services ( is installed. For any SQL Server 2005 Notification Services installation issues, see SQL Server 2005 Notification Services Components Readme (
Scenario / ActionSQL Server not upgraded. / No action required
SQL Server2008 upgraded to SQL Server2008 R2 SP1. / No action required
SQL Server2005 upgraded to SQL Server2008 R2 SP1 or SQL Server 2012 (with or without EDI configured). / Using the bm.exe program located in the BizTalk Server Tracking folder (%SystemDrive%\Program Files\Microsoft BizTalk Server 2010\Tracking), run the following at the command prompt with administrative credentials:
bm.exe migrate-sql [-From:sql2005 -To:sql2008][ -NSUser:<notifications service user name> ][ -NSUserPassword:<Notifications Service user password> ][ -Server:<Server name> ][ -Database:<Database name> ]
Reconfigure the following SQL Server Agent jobs:
DTA Purge and Archive (BizTalkDTADb) job. For more information, see How to Configure the DTA Purge and Archive Job (
Backup BizTalk Server (BizTalkMgmtDb) job. For more information, see How to Configure the Backup BizTalk Server Job (
Restart all deployed applications that are upgraded to BizTalk Server 2013.
When you open the BAM portal, you may receive the following error message: The server encountered a critical failure while trying to access the list of Views. The Business Management Web Service requires Administrator's attention. This error can occur if the BAM portal is configured on a website used by applications that are running .NET Framework 2.0. In this case, host the BAM portal on a new website. To add a website, see Create a Web Site (IIS 7) ( After creating the website, follow these steps:
a.Open BizTalk Server Configuration.
b.Click Unconfigure Features. In the Unconfigure Features dialog box, select the BAM Portal check box and click Ok.
c.Reconfigure the BAM portal by selecting the new website from the BAM Portal Web Site list.
BizTalk 2013 Accelerator for SWIFT. The BizTalk Server upgrade process does not update an edited BREDeployment.exe.config file. Manually change the paths in the BREDeployment.exe.config file located in the <drive>:\Program Files\Microsoft BizTalk 2013 Accelerator for SWIFT\SDK\Tools folder.
Also, the A4SWIFT Web Services and Message Pack 2012 configuration is lost. Reconfigure these after BizTalk Server is upgraded.
Considerations for BAM
When you are upgrading BAM, the free disk space should be at least the size of the existing BAM databases.
If you are using BAM real-time aggregations in your current version of BizTalk Server and are upgrading to SQL Server2008 R2 SP1, install or upgrade to the Enterprise Edition. Otherwise, the upgrade fails.
If you have a large BAM database, update the maxTimeout value for distributed transactions in your Machine.config file. The value should be the following:
<system.transactions>
<machineSettings maxTimeout="23:59:59" />
</system.transactions>
BAM tracking enabled with Tracking Profile Editor (TPE): After you upgrade to BizTalk Server 2013, tracking profiles that were previously deployed are upgraded; however, their corresponding interceptor configurations are not upgraded. Any new intercepted BAM messages may still have the BizTalk Server2010/2009 references. To upgrade the corresponding interceptor configurations, use the Tracking Profile Editor to retrieve the profile for the activity, and then reapply the profile.
If you are using BAM in BizTalk Server2010/2009, after the upgrade, you must manually regenerate the LiveData Workbook. To regenerate the LiveData Workbook, follow these steps:
a.Retrieve the BAM Definition by running the following command:
BM get-defxml MyDef.xml
b.Re-create the PivotTable reports by opening Microsoft Office Excel and then selecting the BAM Add-ins. Import the MyDef.xml file created in Step 1 and recreate the PivotTable reports. Save the new BAM Workbook as MyNewBook.xls.
c.Rename the PivotTable reports by finding the PivotTable names in MyDef.xml under <Caption> in the path <BAMDefinition>\<Extension>\<OWC>\<PivotTableView>\<PivotTable>\<PivotView>\<Label>. Use these names to rename your PivotTable reports in MyNewBook.xls.
d.Regenerate the LiveData Workbook by running the following command:
BM regenerate-livedataworkbook MyNewBook.xls
Note
Regenerated LiveData Workbooks do not recreate the Excel artifacts (for example, charts) in the original LiveData Workbook. Manually recreate the artifacts.
Considerations for Enterprise Single Sign-On (ESSO)
Consider the following before you start the BizTalk Server 2013 upgrade.
Upgrading from an Earlier Version of Enterprise Single Sign-on
BizTalk Server 2013 includes an updated version of Enterprise Single Sign-On (ESSO). If you are installing this release on a computer with an earlier version of BizTalk, ESSO is automatically updated during setup. We recommend that you perform the following steps before upgrading: