BizTalk Server 2006 Documenter

Project Description

This tool creates documentation for a given BTS 2006 or 2009 installation. It can be run on an ad-hoc basis using the UI or from the command line as a post build/deploy task to create a compiled help file describing a BTS 2K4 installation.

It will compile:
• BTS Host configuration
• Send/Receive port configuration
• Orchestration diagrams complete with any custom code
• Schema and Map content
• Pipeline process flow
• Adapter configuration
• Rule engine vocabularies and policies
• More…

and publish them as compiled help files or Word 2003 XML. Optionally you can embed custom HTML content and custom descriptions for all BTS artifacts to produce a more customized look and feel to the CHM output.

Current Release

The current release is v_3.3.0.0. The MSI and the source code are uploaded and in sync. Please see the downloads page for the release notes
Known Issues:

• The Word output does not include the images of the orchestrations. This is because we are writing to Word XML directly and there is no data about the image.
• An old bug carried over is that the Output Folder can be selected but not the file name itself. This should be fixed in the next point release.

Screenshots

The screenshow below shows some of the information collected about an Orchestration, you can see what variables, maps, messages, ports, correlation sets, etc. that are used by a given Orchestration.



The screenshot below shows further orchestration information which is collected, in this case we can see all of the inline code written by the developer for the orchestration, useful for code reviews and understanding a solution.

Runtime Instructions

Run GUI from Start menu -> BizTalk 2006 Documenter or from the command line as follows:

Command Line Usage:

Microsoft.Sdc.BiztalkDocumenter.exe options

Options:
/outputdir The output directory for the report. Default %TEMP%.
/server The BizTalk 2004 database server name (incl. instance). Default %COMPUTERNAME%.
/database The BizTalk 2004 management database name to query. Default BizTalkMgmtDb.
/title The documentation file name.
/report The type of documentation to produce. complete (default) or schema.
/provider The documentation provider to use. chm (default) or word.
/show Show the documentation output when complete.
/defaults Run the documenter with all the defaults.

/rules Include business rule documentation. true or false (default).

/rd Business rules database name. Default BizTalkRuleEngineDb.
/rs Business rules server name. Default %COMPUTERNAME%.
/commentfile The full path to an XML file containing custom comments for BTS artifacts.
/help or /? This message.

Examples:

• Microsoft.Sdc.BiztalkDocumenter.exe /def
• Microsoft.Sdc.BiztalkDocumenter.exe /s:MyServer\INST1 /t:MyReportName /p:word
• Microsoft.Sdc.BiztalkDocumenter.exe /s:MyServer\INST1 /r:schema /p:chm /o:C:\Docs\BTS