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.
BizTalk Reports Folder
When you select a report, you are prompted to specify the application that you want to document.
Orchestration Summary Report
Send Port Subscriptions Report
You can download the sample in the following link: BizTalkConfigurationReport-zip.pdf
How to install the solution.
- Rename “BizTalkConfigurationReport-zip.pdf” to “BizTalkConfigurationReport.zip” (wordpress doesn’t allow zip files);
- Unzip the package;
- Run SetupDb.cmd command to create the database;
- Run SetupReport.cmd to deploy report;
- 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.