BizTalk Configuration Reports

Documenting the integration flows is an activity very expensive in terms of time. If we think to the configuration of the receive ports, send ports and how they are linked to the orchestrations we become crazy.

In a context where they develop many BizTalk objects you end up having documents constantly obsolete.

For this reason, I decided to develop a small package of reports that allow having this part of the documentation always up to date. Simply run reports and export them in the required format such as Microsoft Word, PDF or Microsoft Excel.

You can download the installation package at https://github.com/pellitteris/BizTalkConfigReports.

The solution includes a package of reports developed with Microsoft SQL Server Reporting Services and a database to be installed on the same SQL Server instance where the database BizTalkMgmtDb resides. This database contains the views and stored procedures performed by the reports.

Once the installation is completed you have three reports:

 

  • Orchestration Summary
  • Orchestrations
  • Receive Port with Port Subscription

 

 

Orchestration Summary

The report “Summary Orchestration” displays at a high level the relationship between the orchestrations, the receive ports and the send ports.

Each report allows you to select the application, and optionally a search string to filter the objects you want to examine or document.

 

 

Following an example of this report.

 

 

Orchestrations

The report “Orchestrations” adds more details to the previous report.

 

 

Finally the report “Receive Port having Send Send Port or Port Group Subscriptions” that displays all subscriptions to a specific port configured on the send port or on the send port group.

 

 

Now you have the source code of this solution and you can add features or simply customize reports to fit your needs.

Advertisements

BizTalk Configuration Reports

In all integration projects that I made, I had to provide documentation relating to ports configurations especially in terms of addresses.

Moreover, what is need is a vision for integration flow and not by type of objects. So not a document that lists all the receive ports with all configurations, all orchestration with all configurations and all send ports with all configurations, but a document that divides objects by integration flow. E.g. flow number 1: receive ports, orchestration and send ports involved.

In addition, the configurations in this sense, change often and it is not easy to keep up to date documents.

For this reason I have developed some reports based on Microsoft Reporting Services that provide this vision of a configuration of a BizTalk Server farm for what concerns the ports, orchestrations and pipelines.

It is just an example, but which can be extended or modified as needed.

The example solution that I made is based on a database and a small group of reports.

In the database there are views and stored procedures needed to execute the reports, containing only data access logic to the tables of the BizTalk Management database (BizTalkMgmtDb), so it must be created in the same instance of the BizTalk operating databases.

Note that if the database management has a different name from BizTalkMgmtDb, the setup script (BizTalkReport.sql) should be modified specifying the correct name.

The advantage of using SQL Server Reporting Services is that you can access the documentation online, or you can export your documents in different formats such as PDF, Word, Excel and so on in order to be included in the project documentation.

Once you install the report and the database you get the scenario shown in the following figures.

Home Page

clip_image002_thumb2_thumb_thumb

BizTalk Reports Folder

clip_image004_thumb3_thumb_thumb

When you select a report, you are prompted to specify the application that you want to document.

clip_image005_thumb2_thumb_thumb

Orchestration Summary Report

clip_image007_thumb2_thumb_thumb

Orchestrations Report

clip_image009_thumb2_thumb_thumb

Send Port Subscriptions Report

clip_image011_thumb2_thumb_thumb

You can download the sample in the following link: BizTalkConfigurationReport-zip.pdf

How to install the solution.

  1. Rename “BizTalkConfigurationReport-zip.pdf” to “BizTalkConfigurationReport.zip” (wordpress doesn’t allow zip files);
  2. Unzip the package;
  3. Run SetupDb.cmd command to create the database;
  4. Run SetupReport.cmd to deploy report;
  5. Configure data source credential for the report.

The user that access the report should be member of SSO Administrators and BizTalk Administrators, so you have to configure the data source credential as follow.

clip_image013_thumb2_thumb_thumb