How can Visio Stencil for BizTalk Server help you documenting BizTalk Infrastructures or Integration projects

Posted: December 7, 2013 in BizTalk
Tags: , , , , ,

Some time ago, I do not remember when or where I was asked to provide some examples of diagrams that I use in my documentation or some diagrams representations in which I use the Visio Stencils for BizTalk Server

I know that no one likes to create documentation, is boring, it can be a challenging task, but documentation is an important part on every BizTalk Integration projects or for infrastructures operations management and administration. They will help you in many critical situation and will reduce the time needed to carry out different procedures like finding were the machines are hosted, how many machines your environment have, what are the actors (systems, protocols) in a given solution and so on. You can have at least three types of documentation when it comes to BizTalk:

  • Infrastructure Overview
  • Solution Overview
  • Technical Overview

Or as Steef-Jan mentioned in one of this posts:

  • BizTalk Environment (Design) document
  • Functional Design of BizTalk Solution
  • Technical (Design) of BizTalk Solution

Visio is great for creating multiple kinds of diagrams, unfortunately, the set of stencils and shapes, which out-of-the-box come with Visio provably are not sufficient to cover the kinds of diagrams we need with our BizTalk/Integration projects or they are not easy to use and read. Visio 2013 Stencil for BizTalk Server and Visio 2010 Stencil for BizTalk Server can easily help you creating documentation for the first two: BizTalk Environment (Design) document and Functional Design of BizTalk Solution. They are a collection of 73 modern flat Visio 2013 shapes that will help you representing BizTalk Server physical architectures, Integration architectures (Cloud or Hybrid scenarios) or solutions diagrams in Visio 2013 and 2010.

Infrastructure Overview Samples

This logical diagram describes the overview of your BizTalk environments where you can specify the Infrastructure of your production, UAT, testing or developer environments.

Here are some samples of:

  • Complex logical diagram of your Infrastructure

BizTalk-Infrastructure-Overview-Samples-1

  • Basic logical diagram of your Infrastructure

BizTalk-Infrastructure-Overview-Samples-2

  • Or for example a diagram representing a logical diagram of your BizTalk Group and Host Infrastructure

BizTalk-Host-Infrastructure-Overview-Sample

Solution Overview Samples

This logical diagram depicts a view of the solution. It will describe how solution will work, who are the actors, what type of protocols and so on.

Here are some samples of solution diagrams:

  • Complex logical diagrams

BizTalk-Solution-Overview-Sample BizTalk-Solution-Overview-Sample-2

  • Or basic logical diagram

BizTalk-Solution-Overview-Sample-3

This documentation should be available to all stakeholders within your organization: developer, operation and administration team.

Contrary to what many might think some kind of documentation is pretty straight forward and can be realized with minimal effort but have an enormous importance in the organization when you need to make changes inside your solution or infrastructure.

You can download BizTalk Infrastructure and Solution Overview Samples from:

BizTalk Infrastructure and Solution Overview Samples (11.4 MB)
Microsoft | TechNet Gallery

About these ads
Comments
  1. Guilherme says:

    Hi Sandro,
    When I saw the title of the post I thought “great, the answer for my biggest question” but It wasn’t exactly what I was expecting. Actually this post is very useful – THANKS, however I have another documentation issue I was never able never find a positive answer and maybe you can point me to the right direction: Is there a way to document complex maps from the map tool, grouping stuff (on the same page), commenting structures and so on?
    Thanks
    Guilherme

Leave a Reply

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

WordPress.com Logo

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

Twitter picture

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

Facebook photo

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

Google+ photo

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

Connecting to %s