BizTalk2010Autodc Wiki Rss Feed

Updated Wiki: User Guide

RedEyedMonster — Wed, 12 Oct 2011 11:04:22 GMT

User Guide

Download the msi from the downloads page and run it on the BizTalk Server you wish to document. This will create a shortcut on the desktop from which you can fire up the documenter.

The application should pick up the Management Server and Database Names. I have not tested against a rules engine so would appreciate feedback on this. Browse to the path for the exported BizTalk Configuration in the bottom box.

To export the BizTalk installation configuration open the BizTalk Server Configuration Utility and select 'Export Configuration'.

The next page of the documenter allows you to view and save orchestration diagrams.

On the next page you can specify whether to document all the BizTalk applications on the server or select from a list.

On page 4 select which SSO applications you wish to document. If you like you can choose to include exported (xml) SSO applications. To understand the schema required select and document the application from the top box and then look at the source in the produced documentation.

Finally choose the Report Title, Output Folder (where the help will be produced) and Output Provider (Note: Only the 'Compiled Help' option gives complete documentation at this moment in time). You can choose a resource folder that contains additional HTML documentation that you want to include.

Select 'Generate Documentation'

and you should end up with something like this.

Updated Wiki: User Guide

RedEyedMonster — Wed, 12 Oct 2011 11:03:36 GMT

User Guide

Download the msi from the downloads page and run it on the BizTalk Server you wish to document. This will create a shortcut on the desktop from which you can fire up the documenter.

To export the BizTalk installation configuration open the BizTalk Server Configuration Utility and select 'Export Configuration'.

The next page of the documenter allows you to view and save orchestration diagrams.

On the next page you can specify whether to document all the BizTalk applications on the server or select from a list.

On page 3 select which SSO applications you wish to document. If you like you can choose to include exported (xml) SSO applications. To understand the schema required select and document the application from the top box and then look at the source in the produced documentation.

Select 'Generate Documentation'

and you should end up with something like this.

Updated Wiki: Home

RedEyedMonster — Sat, 24 Sep 2011 01:31:09 GMT

Overview
Having recently become involved in BizTalk I was happy to find the BizTalk Server 2006 Documenter but unfortunately it did not run correctly in the environment that I was using. I have spent some time modifying, fixing and enhancing the application for use in the environment I use in my work. The project now includes modified files from the BizTalk OM project and the SSO Config project. It has been compiled in Visual Studio 2010 and tested on BizTalk 2010 running on Windows Server 2008 R2. Having now used it to successfully document the environments in my workplace I thought I should offer the installation files and source code to those who may find it useful as I found the original BizTalk Server 2006 Documenter.

Project Description
I have not removed any of the functionality of the original project. In this edition I have concentrated on the GUI and the compiled help functionality. So the description remains the same as it did for the BizTalk Server 2006 Documenter, with the following fixes/enhancements:

GUI modified to resemble more of a wizard, step by step style.
Fixed, click through functionality on Orchestration diagram
Transformations added to Orchestration Code Elements page including input and output message(s).
New click through functionality on above transformations
Fixed, object descriptions pulled through into documentation (Code Elements page)
Added, SSO integration. Will now document SSO applications
Fixed, Documents exported BizTalk configuration file (xml)
Enhanced, can now include additional HTML documentation by selecting folder it is held in. These documents appear under 'Additional Notes'. Any file called titlePage.htm will replace the default title page.

Known Issues

Will not run successfully if a .chm file is open of the same name and path of the one you are trying to create.
Needs to be run on the actual server you are documenting.
Word documentation is incomplete (I have not done any work on this side of things yet).
Rules Engine documentation not tried or tested.
See BizTalk Server 2006 Documenter for other issues.

Updated Wiki: Home

RedEyedMonster — Sat, 24 Sep 2011 01:28:39 GMT

Project Description
I have not removed any of the functionality of the original project and the source code there is complete. In this edition I have concentrated on the GUI and the compiled help functionality. So the description remains the same as it did for the BizTalk Server 2006 Documenter, with the following fixes/enhancements:

GUI modified to resemble more of a wizard, step by step style.
Fixed, click through functionality on Orchestration diagram
Transformations added to Orchestration Code Elements page including input and output message(s).
New click through functionality on above transformations
Fixed, object descriptions pulled through into documentation (Code Elements page)
Added, SSO integration. Will now document SSO applications
Fixed, Documents exported BizTalk configuration file (xml)
Enhanced, can now include additional HTML documentation by selecting folder it is held in. These documents appear under 'Additional Notes'. Any file called titlePage.htm will replace the default title page.

Known Issues

Will not run successfully if a .chm file is open of the same name and path of the one you are trying to create.
Needs to be run on the actual server you are documenting.
Word documentation is incomplete (I have not done any work on this side of things yet).
Rules Engine documentation not tried or tested.
See BizTalk Server 2006 Documenter for other issues.

Updated Wiki: Home

RedEyedMonster — Sat, 24 Sep 2011 01:22:09 GMT

Overview
Having recently become involved in BizTalk I was happy to find the BizTalk Server 2006 Documenter but unfortunately it did not run correctly in the environment that I was using. I noticed that there had been little activity on the project in over a year so I did a little digging and was sad to discover that one of the developers had been killed in a house fire. Which I presume is the reason for the projects halt.

Since downloading the code from the original project I have spent some time modifying, fixing and enhancing the application for use in the environment I use in my work. The project now includes modified files from the BizTalk OM project and the SSO Config project. It has been compiled in Visual Studio 2010 and tested on BizTalk 2010 running on Windows Server 2008 R2. Having now used it to successfully document the environments in my workplace I though I should offer the installation files and source code to those who may find it useful as I found the original BizTalk Server 2006 Documenter.

GUI modified to resemble more of a wizard, step by step style.
Fixed, click through functionality on Orchestration diagram
Transformations added to Orchestration Code Elements page including input and output message(s).
New click through functionality on above transformations
Fixed, object descriptions pulled through into documentation (Code Elements page)
Added, SSO integration. Will now document SSO applications
Fixed, Documents exported BizTalk configuration file (xml)
Enhanced, can now include additional HTML documentation by selecting folder it is held in. These documents appear under 'Additional Notes'. Any file called titlePage.htm will replace the default title page.

Known Issues

Will not run successfully if a .chm file is open of the same name and path of the one you are trying to create.
Needs to be run on the actual server you are documenting.
Word documentation is incomplete (I have not done any work on this side of things yet).
Rules Engine documentation not tried or tested.
See BizTalk Server 2006 Documenter for other issues.