Documentation is always an important part of any project. Automating the documentation hasn’t been achieved its excellence. But various documentation tools are available for public use which will help us to create a decent base. One of them is Darren Jefford’s BizTalk documenter.
Download BizTalk 2006 Documenter:
http://www.codeplex.com/BizTalkDocumenter/
I have always found this tool handy whenever I have been asked to work on an existing BizTalk solution. For instance lets say you have been asked to work on an existing BizTalk Solution which comprises of 40 projects!!! Navigating through its reference projects, to understand the flow is always a painful process. I always use this tool to generate a help-file out of these BizTalk projects.
In another project, since my client was very much satisfied with the document generated by this tool, I have configured to run this tool as part of automated build (used MS-Build). so whenever our project changes, the project document will also be updated accordingly.
This tool is simple self-describing tool. But I have faced some problems initially and the solution is as follows.
- Make sure that you have the HTML-Help compiler when you have opt to generate HTML-Help version (MS-Word version is also available) of document. Download the HTML-compiler from here:
- “Unable to locate the help compiler executable”
Ensure the “HelpComplieLocation” variable is assigned to the exact path of the Help compiler “*.exe” file in the BizTalkDocumenter.exe.config file
- “There was an error generating the XML document.”
This error is due to tracking enabled in any of your send port. Just for documentation sake disables the tracking in your send port and rerun the tool again.
- “Item has been already added. Key in dictionary: 'xxx.xxx.xxx.Orchestration' Key being added:'xxx.xxx.xxx.Orchestration'”
In rare case this error might occur. Ensure you have selected only the required BizTalk Applications in “Select Documentation Type”.
0 comments:
Post a Comment