Basic Hardware and Software requirements
Set up and install prerequisites
Installation Guide
Configure BizTalk Server 2020
Basic Hardware and Software requirements for BizTalk Server 2020 Installation
BizTalk Server 2020 Hardware Installation requirements:
The list bellow shows the least hardware requirements for your BizTalk Server computer. The amount of traffic in a production environment may need further hardware requirements for your servers.
- COMPUTER AND PROCESSOR: A computer with an Intel Pentium-compatible CPU that is:
o 4 GHz or higher
Hyper-threading and multi-core processors are supported.
The 64-bit versions of BizTalk Server demand a 64-bit operating system running on a x64-based system. Computers based on CPUs that are compatible with AMD64 (x86-64) and Extended Memory 64-bit Technology (EM64T) processor architecture are considered x64-based systems.
BizTalk Server is not supported on Itanium-based systems.
- Memory: 4 GB or more
- Hard disk: 10 GB of available hard disk space for a complete installation, including the operating system and all prerequisite software. The hard disk must be NTFS formatted.
Advice:
These hardware requirements listed above are the minimum.Because most environments differ from each other, there is a good possibility that your environment needs more, depending on throughput and load. See Recommendations for Installing, Sizing, Deploying, and Maintaining a BizTalk Server Solution. Additionally refer to Windows System requirements for Windows Server 2016 and Windows Server 2019.
BizTalk Server 2020 Software requirements & supported versions for Installation
- Microsoft Windows: Required. Supported versions contain:
o Windows Server 2019
o Windows Server 2016
o Windows 10
- Internet Information Services (IIS): Delivers a scalable web application foundation; the EDI, BAM, Management REST API requires it, as well as the SharePoint adapter.
IIS is integrated with the Windows operating system.
- Windows Identity Foundation: It’s optional and is used by the Windows SharePoint Services Client Side Object Model (CSOM), and it’s automatically installed with BizTalk Server installation.
The Windows operating system includes Windows Identity Foundation as a Feature.
- Microsoft SharePoint: It’s optional. If you wish to send or receive messages from SharePoint Services, then a SharePoint Services computer is required. It can be installed on the same computer as BizTalk Server, or rather on a different computer.
Supported versions:
o SharePoint Services 2019
o SharePoint Services 2016
o SharePoint Services Online
- Microsoft Office: it’s optional. Required by Business Activity Monitoring (BAM) to show a real-time view of business processes.
Supported versions:
o Microsoft Office Excel 2019
o Microsoft Office Excel 2016
BizTalk Server supports only 32-bit versions of Office.
- Microsoft .NET Framework: Required for all BizTalk Server managed components. BizTalk projects created in Visual Studio require the Visual Studio build target be set to your .NET
Framework version.
Supported versions:
o .NET Framework 4.7
- Microsoft Visual Studio: It’s optional. Delivers a development environment for building BizTalk Server applications. Latest Edition is recommended, but Premium and Professional are also supported. Required for BizTalk Server Developer Tools and SDK.
Supported versions:
o Visual Studio 2019
- Microsoft Visual C++ 2015-2019 Redistributable Package: It’s required. The Microsoft Visual C++ Redistributable Package installs runtime components of Visual C++ Libraries required to run applications developed with Visual C++ on a computer that doesn’t have Visual C++ installed.
Supported versions:
o The x86 and x64 versions are required. Download at Visual C++ 2015-2019 Redistributable Package x86 and Visual C++ 2015-2019 Redistributable Package x64.
- Microsoft OLE DB Driver for SQL Server: It’s required on all BizTalk Server devices.
Supported versions:
o Microsoft OLE DB Driver 18.3.0 for SQL Server. Download at Microsoft OLE DB Driver for SQL Server.
- Microsoft SQL Server: It’s required for BizTalk Server Runtime, EDI, and BAM. For prime performance, Microsoft recommends the Enterprise Edition of SQL Server. Other considerations:
o To use SQL Server AlwaysOn Availability Groups (AG), use SQL Server 2016 SP2 CU7 and most recent versions. Starting with SQL Server 2016, AlwaysOn AG supports MSDTC; MSDTC is required by BizTalk.
o BAM real-time aggregation (RTA) is not supported in the Standard Edition of SQL Server. To use BAM RTA, install SQL Server Enterprise Edition.
o Using SQL Server Express Edition is not suggested The Express edition does not include certain features needed by BizTalk Server.
o BizTalk Server supports all case-sensitive and case-insensitive SQL Server collations except for binary collations. Binary collations are not supported.
Supported versions:
o Microsoft SQL Server 2019
o Microsoft SQL Server 2017
o Microsoft SQL Server 2016 SP2
- SSIS Catalog (SSIDB): Optional. Required to use BAM. Create the SSIS Catalog.
- SQL Server Database Mail: Optional. Required to use BAM Alerts. SQL Server Database Mail is included with SQL Server.
- SQL Server Analysis Services ADOMD.NET: Optional. Required to use BAM Alerts.
Supported versions:
o SQL Server 2016 Analysis Services ADOMD.NET. Download at SQL Server 2016 Feature Pack.
- WinSCP: Required to use the SFTP adapter.
Supported versions:
o WinSCP version 5.15.4. Download at WinSCP.
- MQSeries adapter: It’s optional. Necessary only when using IBM WebSphere MQ.
Supported versions:
o IBM WebSphere MQ 8
o IBM WebSphere MQ 9
- LOB and enterprise systems: Necessary when using the adapters in the BizTalk Adapter Pack. BizTalk Adapter Pack lists the available system adapters.
Supported Line-of-Business (LOB) and Enterprise systems
Service Pack and Cumulative Update Support
All service packs, cumulative updates, security updates, and hotfixes are supported on a BizTalk Server. It is highly suggested installing the latest update for Windows, SQL Server, Visual Studio, and any program installed. Service Packs for Microsoft products are supported based on the baseline support for that product. Refer to Support Lifecycle Index for BizTalk Server, SQL Server, Visual Studio, and other Microsoft programs.
Service Pack and cumulative update list for BizTalk Server
NEXT STEP ↓
BizTalk Server 2020 Set up and install prerequisites guide
Set up and install prerequisites for BizTalk Server 2020
Set up the server, install and configure the software prerequisites.
Join the Administrators Group
For installing and configuring BizTalk Server, sign in to the server using an administrator account on the local computer. Add any user accounts that are administering the BizTalk Server to the local Administrators group:
- In the Start menu, open Computer Management.
- Or, open Administrative Tools, and then select Computer Management.
- Or, open Server Manager, select Tools, and then select Computer Management.
- Expand Local Users and Groups, and select Groups.
- Right-click the Administrators group, and select Add to Group. Add your accounts, and select OK to save your changes.
Changing the computer name it’s optional
If your computer name is longer than 15 characters, the BizTalk Server configuration will fail. To change the computer name to less than 15 characters:
- In Server Manager > Dashboard, select Local Server.
- In Properties, select the Computer name property to change it.
- Restart the computer.
SEE ALSO: Windows PowerShell Rename-Computer
Enable Network DTC Access
If BizTalk and SQL Server are installed on separate computers, then enable Network DTC Access on the BizTalk Server and the SQL Server.
- In the Start menu, open “dcomcnfg”.
- Or, open Administrative Tools, and then select Component Services.
- Or, open Server Manager, select Tools, and then select Component Services.
- Expand Component Services, expand Computers, expand My Computer, and expand Distributed Transaction Coordinator.
- Right-click Local DTC, and select Properties.
- Go to the Security tab, and check the following:
- Network DTC Access
- Allow Inbound
- Allow Outbound
- No Authentication Required
- Select OK. If prompted to restart MS DTC, select Yes.
For additional settings that may be needed, see Troubleshooting Problems with MSDTC.
Configuring Application Event Log it’s optional
BizTalk Server setup holds a record of events in the Application Event Log. Depending on the BizTalk Server features installed, the amount of space required in the log may exceed its limit. If the application event log runs out of space during the setup, the installation fails. Changing the Application Event Log settings prevents this failure.
- In the Start menu, open Event Viewer:
- Or, open Administrative Tools, and then select Event Viewer.
- Or, open Server Manager, select Tools, and then select Event Viewer.
- Expand Windows Logs, right-click Application, and then select Properties.
- To determine the available space, compare the Log Size and the Maximum log size properties.
- To add space, enter a higher number in Maximum log size.
- To enable overwriting of old events when the log becomes full, select Overwrite events as needed.
- To clear the log events, select Clear log.
- Select OK.
Install Windows Updates
Make sure to install the latest critical Windows updates.
- On the Start menu, open Windows Updates, and check for updates. You can also open Settings, and select Update and security.
- After installing updates, you may need to restart the computer.
Install Visual C++ 2015-2019 redistributable package
Download and install the Visual C++ 2015-2019 redistributable package – x86 and Visual C++ 2015-2019 redistributable package – x64.
The Visual C++ downloads lists all the available versions.
Install Microsoft OLE DB Driver for SQL Server
Download and install the Microsoft OLE DB Driver for SQL Server.
Enable IIS
BizTalk Server requires IIS for the following features:
- HTTP adapter
- SOAP adapter
- Windows SharePoint Services adapter
- Secure Sockets Layer (SSL) encryption
- Management REST API
- BAM Portal
- EDI
IIS is included with the operating system as a Role or a Feature, depending on the OS. To install:
- In the Start menu, open Turn Windows Features on or off. Or, open Server Manager, select Manage, and then select Add roles and features.
- Select Internet Information Services or Web Server (IIS). In addition to the default checked options, also select the following:
Windows 10
- In Web Management Tools, also check:
o IIS 6 Management Compatibility
o IIS 6 Management Console
o IIS 6 Scripting Tools (Installs adsutil.vbs)
o IIS Metabase and IIS 6 configuration compatibility
o IIS Management Console
- In World Wide Web Services, expand Security and also check:
o Basic Authentication
o Windows Authentication
Windows Server
- In Security, also check:
o Basic Authentication
o Windows Authentication
- In Management Tools, also check:
o IIS Management Console
o IIS 6 Management Compatibility
o IIS 6 Metabase compatibility
o IIS 6 Management Console
o IIS 6 Scripting Tools (Installs adsutil.vbs)
- Continue with the installation, and restart the computer if prompted.
Run 64-bit BAM portal it’s optional
If you don’t use the BAM portal, then you can skip this section.
The BAM Portal runs in 32-bit mode. If you are using Internet Information Services (IIS) in a 64-bit environment, then set the application pool to run in 32-bit mode.
Using adsutil.vbs
- Open a command prompt as administrator.
- In the command prompt, type:
cscript c:\inetpub\adminscripts\adsutil.vbs SET W3SVC/AppPools/Enable32bitAppOnWin64 1
- Select Enter.
Using IIS Manager
- In the Start menu, open “inetmgr”.
- Expand the computer name, and select Application Pools.
- Right-click DefaultAppPool, and select Advanced Settings.
- Change the value of Enable 32-bit Applications to True.
- Select OK.
Installing Windows Identity Foundation (WIF) it’s optional
If you use the SharePoint Services adapter, BizTalk Server requires WIF. If you don’t use the SharePoint Services adapter, you can skip this section.
Windows Identity Foundation is included with the operating system as a Feature.
- In the Start menu, open Turn Windows Features on or off. Or, open Server Manager, select Manage, and then select Add roles and features.
- Select Windows Identity Foundation 3.5, and continue with the installation.
- Restart the computer if prompted.
Install SQL Server 2016 Analysis Services ADOMD.NET
Download and install x86 and x64 SQL_AS_ADOMD from Microsoft SQL Server 2016 Feature Pack download.
Installing & configure SMTP Server it’s optional
If you use BAM Alerts, BizTalk Server requires SMTP Server. If you don’t use BAM Alerts, you can skip this section.
SQL Server Database Mail uses an SMTP Server to send BAM Alerts. SMTP Server can be installed locally on the BizTalk Server or on another server with IIS installed. SMTP Server is not available on client operating systems, such as Windows 8.1 or Windows 10.
SMTP Server is included with server operating systems as a Feature.
- In the Start menu, open Turn Windows Features on or off. Or, open Server Manager, select Manage, and then select Add roles and features.
- Select SMTP Server, and continue with the installation.
- Restart the computer if prompted.
Installing Excel 2019 or 2016 it’s optional
If you use Business Activity Monitoring (BAM), BizTalk Server requires Excel. If you don’t use BAM, you can skip this section.
The BAM Office Excel Workbook defines the business processes you want to monitor. You also use the BAM Excel Workbook to define the way business users see the data collected by BAM.
Important Note:
- BizTalk Server supports only 32-bit versions of Microsoft Office.
- To successfully load BAM.xla into Excel, install Visual Basic for Applications (under Office Shared Features). Otherwise, you may get error: This workbook has lost its VBA project, ActiveX controls and any other programmability-related features.
Installing Visual Studio 2019 it’s optional
BizTalk Server requires Visual Studio to create BizTalk projects using the development tools. If this is a staging or production server, or you’re not doing any BizTalk development, then skip this section.
Visual Studio Enterprise Edition is recommended, but Professional and Community editions are also supported.
- Run the Visual Studio setup as Administrator.
- Select a Default installation. BizTalk Server does not require any of the optional features.
- Continue with the installation, and restart your computer if prompted.
SEE ALSO: Installing Visual Studio 2019
Important Note:
- The BizTalk Server development tools are based on Visual Studio. At a minimum, install the .NET desktop development workload before you install the BizTalk Server Developer Tools/SDK and BizTalk Server extension.
- The BizTalk Server runtime requires .NET Framework 4.7.2 or higher.
Install SQL Server
BizTalk Server requires SQL Server. SQL Server can be installed on the same computer as BizTalk, or on a different computer. Most production environments install BizTalk and SQL on separate servers.
Important Note:
- SQL Server Express Edition is not recommended or supported. The Express edition does not include certain features needed by BizTalk Server.
- BizTalk Server supports SQL Standard Edition. However, to use Business Activity Monitoring real-time aggregation (BAM RTA), install SQL Server Enterprise Edition. BAM real-time aggregation (RTA) is not supported in the Standard Edition of SQL Server.
- BizTalk Server supports all case-sensitive and case-insensitive SQL Server collations except for binary collations. Binary collations are not supported.
For specific install steps, Install SQL Server.
- Start the SQL Server installation.
- During the Feature setup, select the following:
- Database Engine Services
- Analysis Services
- Shared Features
o Client Tools Connectivity
o Integration Services
- Configure Analysis Services in Multidimensional Mode. Default is Tabular Mode, make sure to change it to Multidimensional Mode in SQL Server installation wizard before continuing with installation.
4. Continue with the installation, and restart the computer if prompted.
Disable Shared Memory
- Open SQL Server Configuration Manager.
- In SQL Server Configuration Manager, expand SQL Server Network Configuration, and then select Protocols for MSSQLSERVER.
- Right-click Shared Memory, and then select Disable.
- Select SQL Server Services, right-click SQL Server (MSSQLSERVER), and then select Stop. After the service has stopped, right-click SQL Server (MSSQLSERVER), and then select Start.
- Close SQL Server Configuration Manager.
Typically, the Shared Memory protocol only impacts clients (BizTalk Server) that are installed on the same computer as SQL Server. Under certain stress conditions (such as clients accessing SQL Server from the same computer), the SQL Server Shared Memory protocol may lower BizTalk Server performance. Disabling the Shared Memory network protocol resolves this.
Configuring SQL Database Mail it’s optional
If you use BAM Alerts, BizTalk Server requires SQL Server Database Mail. If you don’t use BAM Alerts, then skip this section.
SEE ALSO: More on Database Mail..
Important Note:
- You need to know the server name and TCP port number for the SMTP Server. If you installed IIS and SMTP Server on this same computer, then you use the local SMTP Server. If the SMTP server requires authentication, then have the user name and password ready.
- The BAM portal and BAM Alerts are separate features. If you are using BAM Alerts, then SQL Server Database Mail is required. If you are not using BAM Alerts, then SQL Server Database Mail is not required.
For specific configuration steps, see: Configure SQL Server Database Mail.
To send a test email:
- Right-click Database Mail, and select Send Test E-Mail.
- Enter a To: email address, and select Send Test E-Mail.
If the To: recipient receives the email, then Database Mail is configured.
Creating the SSIS Catalog it’s optional
If you use BAM, BizTalk Server requires SSIS Catalog to be created. If you don’t use BAM, then skip this section.
SEE ALSO: More on SSIS Catalog.
For specific steps to create the SSIS Catalog, see: Create the SSIS Catalog.
Installing WinSCP it’s optional
Required by the SFTP adapter. If you don’t use the SFTP adapter, then skip this section.
Download and install WinSCP.
NEXT STEP ↓
BizTalk Server 2020 Installation Guide.
Install BizTalk Server on a single computer.
Before you begin
- System Administrator: When you install SQL Server, setup automatically grants your signed-in account System Administrator rights. Because these rights are also essential to install BizTalk Server, do one of the following:
o Use the same account you used when you installed SQL Server.
o Provide the signed-in account System Administrator rights.
o Confirm the signed-in account is a member of the local administrator’s group.
- Account names: Use the default account names whenever possible. The BizTalk Server setup automatically enters the default accounts. If there are multiple BizTalk Server groups within the Domain, change the account names to prevent conflicts. If you change the names, BizTalk Server supports only NetBIOS domain name\user for service accounts and Windows groups.
- Account names with BAM Management Web Service: BizTalk Server does not support built-in accounts or accounts without passwords for the BAM Management Web Service User. The web service accesses the BizTalk Server database and these accounts may suggest a security threat.
Important Note
Configuring BizTalk Server with these types of accounts may succeed, but the BAM Management Web Service fails. Built-in accounts or accounts without passwords can be used for the BAM Application pool.
- Install and Uninstall: Uninstalling BizTalk Server requires manually deleting the BizTalk Server databases. If you are installing BizTalk Server as a developer or evaluator, use a virtual machine. If you need to reinstall, you can easily roll back the virtual machine without having to uninstall and delete the databases.
- 32-bit and 64-bit computers: There are few differences when installing BizTalk Server on 32-bit or 64-bit computer. The installation and configuration covers 32-bit and 64-bit computers. Any differences are noted.
- Workgroups – Installing and configuring BizTalk Server in the workgroup environment on a single computer is supported. SQL Server and BizTalk Server features and components are installed and configured on the same computer.
Install BizTalk Server 2020
- Close any open programs. Run the BizTalk Server setup as an Administrator.
- Select Install Microsoft BizTalk Server 2020.
3. Enter your User name, your Organization, and your product key. Select Next.
4. Accept the license agreement, and select Next.
5. Choose to participate in the Customer Experience Improvement Program, and select Next.
6. Choose the components you want to install:
Be sure to select Additional Software. You can also change the installation location:
Depending on the components you choose, there may be some additional prerequisites, such as ADOMD.NET. You need to manually install the missing prerequisites.
Select Next.
- Review the summary page. To make any changes, select Back to check or uncheck any components.
To enable auto-logon after a system reboot, select Set, and enter the sign-in account. This is only enabled during the BizTalk setup. When setup is complete, this setting is disabled.
Select Install.
- To complete Developer Tools component installation, install BizTalk Server extension in Visual Studio.
9. To configure BizTalk now, check Launch BizTalk Server Configuration. If you don’t want to configure BizTalk now, then uncheck this option, and select Finish to close the installation wizard.
A setup log file is generated in a temp folder, similar to:
C:\Users\*username*\AppData\Local\Setup(011217 xxxxxx).htm.
Check the installation
- BizTalk Server is listed in Programs and Features.
- The HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\BizTalk Server\3.0 registry key lists the BizTalk Server version, the install path, the edition, and other details.
- BizTalk Server Administration, Configuration, and other components are listed in your Apps.
NEXT STEP ↓
Configure BizTalk Server 2020
Configure BizTalk Server using custom configuration or basic configuration.
Basic configuration vs. Custom configuration
- If your configuration uses domain groups, do a Custom Configuration.
- If your configuration uses custom group names instead of the default group names, do a Custom Configuration.
- If your configuration uses custom database names instead of the default database names, do a Custom Configuration.
- If BizTalk Server and SQL Server are on separate computers, domain groups are required. As a result, do a Custom Configuration.
- You cannot configure BAM Analysis on a SQL Server named instance using Basic Configuration. If you are using named instances and want to configure BAM Analysis, do a Custom Configuration.
- Basic Configuration is recommended for users setting up a complete installation of BizTalk Server and SQL Server running on a single server.
- Basic Configuration is faster because it automatically creates the local groups and databases using the default names.
Before you begin
- BizTalk Server can be configured using SQL Server default instances and named instances.
- The account you are logged on as must be a member of the local administrator’s group and have System Administrator (SA) rights on SQL Server.
- If you use Domain Groups, the Domain Groups must exist before configuring BizTalk Server.
- The default accounts generated by BizTalk Server and listed in the BizTalk Server Configuration are local groups. In a multiserver environment, replace the local groups with domain groups.
- If you configure BAM Analysis Services, then the account you are logged on as must be a member of the OLAP Administrators group on the OLAP computer.
- Starting with BizTalk Server 2020, BAM uses SSIS Catalog for deploying and managing BAM DTS packages. Create SSIS Catalog on the target SQL Server before configuration.
- Install Cumulative Updates (CUs) or Feature Packs (FPs) after you configure BizTalk Server. Some updates included in CUs or FPs only target artifacts that are configured. If you install CUs or FPs before you run configuration, reinstall the CUs and FPs after you configure. This makes sure that all components are patched and upgraded.
Basic Configuration
- In the start menu, right-select BizTalk Server Configuration, and then select Run as Administrator. This opens the configuration wizard.
- Select the following options:
a.Select Basic configuration.
b.The Database server name automatically defaults to the local computer name.
c.Enter the User name and Password for the account that the BizTalk services will run as. As a best practice, create a unique account. Do not use your personal username.
If you enter a User name with administrative credentials on this computer, you receive a warning. This is normal. Select OK to continue.
- Select Configure.
- Review your configuration details, and select Next.
- When the configuration wizard completes, select Finish.
A configuration log file is generated in a temp folder, similar to: C:\Users\username\AppData\Local\Temp\ConfigLog(01-12-2017 0h37m59s).log.
When you do a basic configuration, the following occurs:
- All database names are generated automatically by BizTalk Server.
- All applicable database logon information is run under the account you enter.
- All BizTalk services are generated automatically by BizTalk Server.
- All BizTalk services run under the account you enter. The configuration process grants this account the necessary security permissions on the server and objects in SQL Server.
- All features are configured based on the prerequisite software you installed on the computer.
- Groups are automatically created local to the computer using the default group names.
- The Default Web Site in Internet Information Services (IIS) is used for any feature that requires IIS.
Custom Configuration
- In the start menu, right-select BizTalk Server Configuration, and then select Run as Administrator. This opens the configuration wizard.
- Select Custom configuration, and select Configure.
ADVICE:
Starting with BizTalk Server 2020, group Managed Service Accounts(gMSA) can be used to configure accounts used for various features in BizTalk. For more information, see using group Managed Service Accounts for BizTalk Features.
Configure Enterprise Single Sign-on (SSO)
Before you begin
- When SSO is configured, it cannot be reconfigured using BizTalk Server Configuration. To reconfigure SSO, use BizTalk Server Administration.
- When configuring the SSO Windows accounts using local accounts, enter only the account name. Do not enter the computer name.
- When using a local SQL Server named instance as data store, use
LocalMachineName\InstanceName. Do not use
LocalMachineName\InstanceName, PortNumber.
Steps
- Select Enterprise SSO.
- Configure the following:
- Enable Enterprise Single Sign-On on this computer: Configure this server with SSO settings.
- Create a new SSO system: If this is the first SSO server you are configuring, select this option. This creates and configures the SSO database, creates the master secret (an encrypted security key), and installs the services used by SSO. You must also back up the secret on this secret server.
What you need to know:
o It’s recommended to configure the master secret server as a stand-alone server.
o You must be an SSO administrator while performing this configuration task.
o Only one master secret server can be associated with one BizTalk group. Associating two master secret servers to the same BizTalk group is not supported.
- Join an existing SSO system: If you are adding a BizTalk Server to an existing group, then select this option. The BizTalk Server shares the same SSO configuration and databases with the other BizTalk Servers in the group.
- Data stores: Enter the server name of your SSO server. If you are on the SSO server, then select the local server name. You can keep SSODB as the default database name, or enter something custom.
- Windows service: Enter the account used to run the Enterprise Single Sign-On service. If SQL Server is on another computer, enter the domain account.
- Windows accounts: You can keep the default group names, or enter something custom. If SQL Server is on another computer, enter the domain accounts.
- Select Enterprise SSO Secret Backup. This option saves the master secret to an encrypted backup file.
- Configure the following:
- Secret backup password: Enter the master secret password.
- Confirm password: Re-enter the master secret password.
- Password reminder: Type a reminder for the password you enter. Seriously – don’t skip this step.
- Backup file location: Lists the backup file name and location. By default, it is stored at \Program Files\Common Files\Enterprise Single Sign-On\ FileName.bak.
ALWAYS backup the master secret, and share the password with another BizTalk Administrator.
Configure Groups
When using a local SQL Server named instance as data store, use LocalMachineName\InstanceName. Do not use LocalMachineName\InstanceName, PortNumber.
- Select Group.
- Configure the following:
- Enable BizTalk Server Group on this computer: Select this option to create a new BizTalk group on this server, or join an existing group.
- Create a new BizTalk Group: If this is the first BizTalk Server in the group, then select this option. You use this option to create the databases, and add the groups.
- Join an existing BizTalk Group: If you are joining this BizTalk Server to an existing group, select this option.
- Create an Analysis database for tracking aggregations: Select this option to install SQL Server Analysis Services, and you want to track and store health monitoring OLAP cubes.
- Data Stores: Enter the server name that hosts your BizTalk databases. If this server has BizTalk and SQL both installed, then enter the local server name. If SQL Server is on another computer, enter the SQL Server name.
You can keep the default database names, or enter something custom.
- BizTalk Administrative Roles: You can keep the default group names, or enter something custom. If SQL Server is on another computer, enter the domain accounts.
Configure the BizTalk Runtime
Before you begin
- Once the Runtime is configured, it cannot be reconfigured using BizTalk Server Configuration. To reconfigure the Runtime, use BizTalk Server Administration.
- The first host you create in the group must be an In-Process host and host instance.
- When you configure the Runtime on multiple BizTalk Servers in the same group, the same service account cannot be used for both the trusted and untrusted host applications. You must use a unique account for the trusted application, and for the untrusted application.
Steps
- Select BizTalk Runtime.
- Configure the following:
- Register the BizTalk Server runtime components: Select this option to create the hosts and host instances on this BizTalk Server.
- Create In-Process Host and Instance: Creates the BizTalkServerApplication host and instance on this computer. Additional options:
o Trusted: Passes the credentials (SSID and/or Party ID) of the sender when submitting messages to the MessageBox database. This is equivalent to creating a trust relationship between the servers. Most hosts and instances are not trusted.
o 32-bit only: Some adapters only run in a 32-bit process but most are 64-bit compliant. This setting can be enabled/disabled in BizTalk Administration after you configure BizTalk. So, don’t stress about it.
o Host name: BizTalkServerApplication is the default. If/when you create new hosts and instances in BizTalk Administration, you can be specific with your names, such as TrackingHost, or ReceivingHost. So, leave this as-is.
- Create Isolated Host and Instance: The isolated host runs within IIS. In many environments, it’s best to keep the default values. Additional options:
o Trusted: Passes the credentials (SSID and/or Party ID) of the sender when submitting messages to the MessageBox database. This is equivalent to creating a trust relationship between the servers. Most hosts and instances are not trusted.
o 32-bit only: Some adapters only run in a 32-bit process but most are 64-bit compliant. This setting can be enabled/disabled in BizTalk Administration after you configure BizTalk.
o Isolated Host name: BizTalkServerIsolatedHost is the default. Leave this as-is.
- Windows service: Enter the accounts used to run the host instances. If SQL Server is on another computer, enter the domain accounts.
- Windows Groups: You can keep the default group names, or enter something custom. If SQL Server is on another computer, enter the domain accounts.
Configure Business Rules Engine (BRE)
If you don’t use BRE, then skip this section.
We recommend that you configure a BizTalk Server group before you configure the Business Rule Engine. If you configure BRE before configuring a BizTalk Server group, the BizTalk Server configuration does not add group-related administrative roles to the Rule Engine database.
- Select Business Rules Engine.
- Configure the following:
- Enable Business Rules Engine on this computer: If you use BRE on this BizTalk Server, then select this option.
- Data Stores: Enter the server name that hosts your Rules database. If this server has BizTalk and SQL both installed, then enter the local server name. If SQL Server is on another computer, enter the SQL Server name. You can keep the default database name, or enter something custom.
- Windows service: Enter the accounts used to run the Rule Update Service. If SQL Server is on another computer, enter the domain account.
Configure BAM Tools
If you don’t use BAM Tools, then skip this section.
The Business Activity Monitoring Tools include:
- BAM add-in for Excel
- BAM Manager
- BAM Portal
Before you begin
- Configuring BAM tools requires certain SQL Server administrative functionality and must be performed from a machine that has Integration Services installed. The version of Integration Services must be equivalent version as your target SQL Server.
- Starting with BizTalk Server 2020, BAM uses SSIS Catalog for deploying and managing BAM DTS packages. Create SSIS Catalog on the target SQL Server (Primary Import and Star Schema database) before configuration.
- The BAM tools may be used by multiple BizTalk groups. When you unconfigure the BAM tools, the connection to the BizTalk group is removed. However, the BAM SQL Server infrastructure continues to work for other BizTalk groups pointing to the BAM Primary Import tables.
- You use the Business Activity Monitoring Tools page to reconfigure the BAM database on-the-fly. For example, configure the BAM database again without removing the existing configuration. Reconfiguring these BAM databases breaks any already-deployed OLAP views and any alerts. If you have existing views and alerts that you want to keep in the newly-configured databases, then do one of the following:
o Undeploy the alerts and views before reconfiguring, and then redeploy them after reconfiguring. Any data that has been archived is not present in the views.
o If you are not using BAM Alerts, then back up the databases before you reconfigure. After reconfiguring, restore the databases to the newly configured location.
o If you are consolidating BizTalk Server databases, you should exclude the BAM Archive, and BAM Analysis databases.
Steps
- Select BAM Tools.
- Configure the following:
- Enable Business Activity Monitoring tools: Enable and install BAM tools on this computer.
- Enable Analysis Services for BAM aggregations: Provides tracking information for BAM alerts.
- Data Stores: Enter the server name that hosts your BAM databases. If this server has BizTalk and SQL both installed, then enter the local server name. If SQL Server is on another computer, enter the SQL Server name. You can keep the default database name, or enter something custom.
- Remove the Business Activity/Monitoring tools for this BizTalk Group: Uninstalls and removes the BAM tools from the BizTalk Group.
Configure BAM Alerts
BAM alerts require BAM tools to be enabled.
BAM Alerts service requires SQL_AS_ADOMD client to run. Install SQL Server 2016 Analysis Services ADOMD from SQL Server 2016 Feature Pack.
- Select BAM Alerts.
- Configure the following:
- Enable BAM alerts: If you use BAM alerts, then check this option. Remember, you must have already configured SQL Database Mail to use BAM Alerts.
- Windows service: Enter the accounts used to run the BAM Alerts service. If SQL Server is on another computer, enter the domain account.
- BAM Alerts SMTP Server: Enter the SMTP Server name that you configured with SQL Database Mail.
- BAM Alerts File Location: Enter a network share to store the BAM alerts. You must manually create this share before BAM alerts can store the files.
- SQL Server for Alerts Databases: Enter the SQL Server name that hosts the Alerts database. Use of IPv6 addresses to specify the NS SQL Server for the Alerts Database is not supported. You can, however, use a computer name and the DNS translation will handle the lookup.
- Prefix for Alerts Database Names: Enter a prefix used for the Alerts databases.
Configure the BAM Portal
- Select BAM Portal.
- Configure the following:
- Enable the BAM Portal: If you use the BAM Portal, then thick this option.
- Web service accounts: Enter the accounts used to run the IIS services. If SQL Server is on another computer, enter the domain accounts.
- Windows groups: You can keep the default group name, or enter something custom. If SQL Server is on another computer, enter the domain account.
- BAM Portal Web Site: Select the Web site to host the BAM Portal. In some environments, the Default Web Site is the only website configured.
Configure BizTalk EDI/AS2 Runtime
- Enterprise SSO, Group, and BizTalk Runtime must be configured before you configure BizTalk EDI/AS2 Runtime.
- BAM Tools must be enabled before configuring the EDI/AS2 Runtime Status Reporting features.
- If you are only configuring EDI, then BAM is not required.
- Select BizTalk EDI/AS2 Runtime.
- Configure the following:
- Enable BizTalk EDI/AS2 Runtime on this computer: If you will use X12, EDIFACT, or AS2 protocols for business-to-business messaging, then select this option.
- Enable BizTalk EDI for this BizTalk Group: Select if you use X12 or EDIFACT.
- Enable BizTalk AS2 for this BizTalk Group: Select if you use AS2.
- Enable BizTalk EDI/AS2 Runtime Status Reporting for this BizTalk Group: Enable the reporting user experience to provide the status of EDI interchanges and acknowledgments.
- Remove BizTalk EDI, AS2 and Status Reporting functionalities from this BizTalk Group: Uninstalls and removes the reporting feature from the group.
Configure Windows SharePoint Services web service – BizTalk Server 2013 and R2 only
Important Note:
This section ONLY applies to BizTalk Server 2013 R2 and BizTalk Server 2013. If you’re not using BizTalk Server 2013 R2 or BizTalk Server 2013, then skip this section.
- This SharePoint Services web service (SSOM) is removed starting with BizTalk Server 2016, and deprecated in BizTalk Server 2013 R2. It is replaced with the SharePoint Services Adapter (CSOM). The CSOM option is not displayed in the BizTalk configuration. The CSOM option is installed automatically with BizTalk, just as the File adapter, or the HTTP adapter is installed automatically.
- Select Windows SharePoint Services Adapter.
- Configure the following:
- Enable Windows SharePoint Services Adapter on this computer: Select to install the SharePoint Services web service. An IIS web service is installed on the SharePoint Services computer, which can be on the same computer as BizTalk Server or a separate computer. In most environments, BizTalk Server and SharePoint Services are on separate computers.
- Windows group: You can keep the default group name, or enter something custom.
- Windows SharePoint Services Adapter Web site: Select the Web site that hosts the Windows SharePoint Service Adapter web service.
Configure the REST APIs
This feature applies to BizTalk Server 2020 and newer.
- Select REST APIs.
- Configure the following:
- Enable BizTalk REST APIs: Check this if you want to enable BizTalk REST APIs.
- Web service accounts: Enter the account used to run the IIS services:
o Management Service: REST APIs for BizTalk Server artifacts management. The default URI for Management Service APIs is http(s)://localhost/BizTalkManagementService.
o Operational Data Service: Service providing information on the instances and messages flowing through your BizTalk Server environment. The operational data feed is the same data you get looking at Group Hub in BizTalk Server Administration. The default URI for Operational Data service APIs is http(s)://localhost/BizTalkOperationalDataService.
- Windows groups: BizTalk REST APIs use Windows authentication, specify the Windows groups allowed to access the APIs here.
o Management REST APIs User Role: Specify name of Windows group as an extra layer of security. Once specified, the requester access to BizTalk information at REST endpoint is limited to what is configured in BizTalk for the specified Windows group(s).
o Operational Data REST APIs User Role: Specify Windows group name that you wish to use to control the access.
- REST APIs website: Select the Web site to host both the REST APIs.
Configure BizTalk TMS
This feature applies to BizTalk Server 2020 and newer.
BizTalk TMS is a service that refreshes authentication tokens used by BizTalk. It is a prerequisite for the Office 365 adapters.
Important Note:
- TMS must be configured on a server which also has the “Enterprise Single Sign-On Service” (ENTSSO) running.
- TMS should only be configured on a single server in a BizTalk Group. For high-availability scenarios, you may configure TMS on multiple servers in an Active-Passive topology.
- Select BizTalk TMS.
- Configure the following:
- Enable BizTalk TMS: Check this if you want to enable BizTalk TMS.
- Service accounts: Enter the account used to run TMS. The service account must be a member of the “SSO Administrators” group.
Apply your configuration
Select Apply configuration, and continue with the configuration.
- In Summary, review the components you selected, and select Next.
- When complete, select Finish.
When finished, a configuration log file is generated in a temp folder, similar to: C:\Users\username\AppData\Local\Temp\ConfigLog(1-12-2017 2h39m30s).log.
IIS application pools and web sites
After you configure BizTalk Server, the following Internet Information Services (IIS) application pools and virtual applications may be created:
Application pools
- BAMAppPool: Application pool for the BAM Portal.
App pool identity: Create your own.
- BTSSharePointAdapterWSAppPool: Application pool for the Windows SharePoint Service adapter Web service.
App pool identity: Create your own.
- STSWebServiceAppPool: Application pool for the Trading Partner Management tools.
App pool identity: Create your own.
- TpmWSAppPool: Application pool for the TPM Management Web service.
App pool identity: Create your own.
- BizTalkManagementServiceAppPool: Application pool for management service REST APIs.
App pool identity: Create your own.
- BizTalkOperationalDataServiceAppPool: Application pool for operational data service REST APIs.
App pool identity: Create your own.
Virtual applications
- BAM: Virtual application that hosts the BAM Portal components, including pages, images, precompiled code, and other resources. This virtual application calls the BAMManagementService application to communicate with the BAM databases. To brand the BAM Portal, you can change the contents of this application.
Default application pool: BAMAppPool
- BAMManagementService: Virtual application that hosts the BAMManagementService web service. This web service is used by the BAM Portal application to communicate with the BAM Primary Import Tables (PIT). The communication with the database is done using impersonated credentials stored in the registry which is created during configuration. Methods exposed by this web service can be used by custom clients to get views and their details, related activities, and pivot table layouts for any user. They can also be used to manage alerts in the database.
Default application pool: BAMAppPool.
- BTSharePointAdapterWS: Virtual application that hosts the Windows SharePoint Service adapter Web service. Applies to BizTalk Server 2013 R2 and 2013 only.
Default application pool: BTSSharePointAdapterWSAppPool
- BizTalkManagementService: Virtual application that hosts the management service REST APIs.
Default application pool: BizTalkManagementServiceAppPool
- BizTalkOperationalDataService: Virtual application which hosts the operational data service REST APIs.
Default application pool: BizTalkOperationalDataServiceAppPool
We encourage you to leave your comments below and check our other posts.
You can also contact us for a free consultation.