Applying Multiple BizTalk Bindings to the Same Environment

File this under “I didn’t know that!”  Did you know that if you add multiple BizTalk binding files (which all target the same environment) to an application, that they ALL get applied during installation?  Let’s talk about this.

So I have a simple application with a few messaging ports.  I then generated four distinct binding files out of this application:

  • Receive ports only (dev environment port configurations)
  • Send ports only (dev environment port configurations)
  • Send ports only (test environment port configurations)
  • Send ports only (all environment port configurations)

The last binding (“all environment port configurations”) includes a single send port that should exist in every BizTalk environment.

Now I added each binding file to the existing BizTalk application while setting environment designations for each one.  For the first two I set the environment to “dev”, set the next send port binding to “test” and left the final send port (“all”) with an empty target (which in turn defaults to ENV:ALL).

Next I exported an MSI package and chose to keep all bindings in this package.

Then I deleted the existing BizTalk application so that I could test my new MSI package.  During installation of the MSI, we are asked for which environment we wish to target.  I chose “dev” which means that both binding files targeted to “dev” should apply, AND, the binding file with no designation should also come into play.

Sure enough, if I view my application details in the BizTalk Administration Console, we can see that a full set of messaging artifacts were added.  Three different binding files were consumed during this installation.

So why does this matter?  I can foresee multiple valuable uses of this technique.  You could maintain distinct binding files for each artifact type (e.g. send ports, receive ports, orchestrations, rules, resources, pipelines, etc) and choose to include some or all of these in each exported MSI.  For incremental upgrades, it’s much nicer to only include the impacted binding artifact.  This provides a much cleaner level of granularity that helps us avoid unnecessarily overwriting unchanged configuration items.  In the future, it would be great if the BizTalk Admin Console itself would export targeted bindings (by artifact type), but at least the Console respects the import of segmented bindings.

Have you ever used this technique before?

Technorati Tags:

Author: Richard Seroter

Richard Seroter is Director of Developer Relations and Outbound Product Management at Google Cloud. He’s also an instructor at Pluralsight, a frequent public speaker, the author of multiple books on software design and development, and a former editor plus former 12-time Microsoft MVP for cloud. As Director of Developer Relations and Outbound Product Management, Richard leads an organization of Google Cloud developer advocates, engineers, platform builders, and outbound product managers that help customers find success in their cloud journey. Richard maintains a regularly updated blog on topics of architecture and solution design and can be found on Twitter as @rseroter.

9 thoughts

  1. I’ve used this several times, and it’s nice (though a pain in the neck to maintain all the binding files). However, one thing to watch out for: Make sure you un-configure the application completely before exporting it.

    Otherwise, when you import the MSI, BizTalk will try to first apply the original bindings (i.e. whatever the app was configured with at the time of export) and *then* apply the selected environment-specific binding files over that, which will not work most of the time.

  2. Hey Tomas,

    But if you don’t select that last “Binding” option during export, that shouldn’t happen. If you keep it selected, then a default binding (matching the current configuration) is added to the MSI. That screwed me up a few times …

  3. This is pretty cool. We’ve got some monster binding files and I forsee using this technique to help us chunk up logical portions of the application (ie, Customer Master, Order Management, etc.). This will also help make branching and merging a little easier too. Thanks for the post!

  4. This sounds great but unfortunately does not work in practice.

    I split my bindings files for each environment into “core” and “test” bindings.

    Basically the core bindings contain everything needed for the application to run, and the test bindings contain just the things necessary for running the bizunit tests.

    Then I baked the bindings for all the environments into an MSI.

    So in the resources view of the application is somthing like:


    However, when selecting the SystemTest option from the environment dropdown when importing the MSI something strange happened.

    The core bindings (with the SystemTest settings) were applied, but so were the test bindings (with the Developement settings)!

    This seems to be something that BizTalk does which is very weird. But there you go…

      1. Sorry the post was misleading in that I was simplifying an example. The actual bindings files are all differerntly named.

  5. Actually I have worked out the reason why. We have a problem in our custom MSBuild tasks which does things in the wrong order. Sorry for the idiocy.

  6. To clarify, we have a problem in our custom MSBuild tasks which adds the bindings as resources, then applies the wrong bindings with BTSTask before the MSI is exported WITH the bindings. So the exported MSI has the wrong bindings regardless of which environment is selected on import.

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.