Open ESB Tip : NetBeans Plugin For Template Based BPEL Documentation
By The Old Toxophilist on Aug 04, 2009
Before this plug-in can be executed you will need to install OpenOffice (or StarOffice) and download the Example Icons and template OpenOffice Document from the (Template Based BPEL Document Generation) blog.
The Module Suite c should be downloaded from the NetBeans Plug-in Portal (zip format) and then extracted. This will provided you with the four NBM files.
- com-tox-doc-nbm.nbm - Documentation Plug-in
- com-tox-doc-gen.nbm - Command-line documentation jar wrapped as a library
- com-tox-doc-nbm-oo.nbm - Minimum OpenOffice Jars wrapped as a library
- com-tox-doc-nbm-batik.nbm - Minimum Batik Jar wrapped as a library
ConfigurationThe plug-in comes with it's own Configuration tab that provides access to all the configuration information that you would have specified in the config.properties files for the command-line version. Before executing the Document Generator for the first time you will need to specify, as a minimum, the OpenOffice Program folder, the template file, the output directory and the Icon Directory. If these are not specified the plug-in will not run and will simply display an error dialog.
Context MenuFor each file with the bpel extension the plug-in provides an additional context-menu entry (Generate Documentation) which will run the Document Generator for the selected bpel.
In addition if you are in the Source view you will also see the same context-menu option when you right-click on the source.
When the menu item is selected it will execute in exactly the same way as the command-line implementation described in the Template Based BPEL Document Generation blog entry.