Element Documentation and Report Generation

The BPEL Designer includes a feature that allows you to create comments (documentation) attached to the elements of a BPEL process. This documentation is then included with the source code of the BPEL process and can later be extracted and included in a report.

Creating Documentation for an Element

1. Select an element on the diagram or in the Navigator window.

2. Click the selected element's Documentation icon which appears next to the selected element in the diagram.

   A documentation window appears.

3. Type any information or comments that you feel are useful, into the Documentation window. This documentation is now available to you whenever you open the Documentation window, and is also written to the element's Properties file.

Generation a Report

The Report Generation feature of the BPEL Designer enables you to generate a PDF document describing the BPEL Process. By creating a custom report you can create a more verbose report or include information for only those elements that have documentation, in the report.

1. From the BPEL Diagram toolbar, press the Generate Report button. The report, in PDF format, is added to the project's Process files in the Projects window.

   The report includes the following information:

   • The name of the process

   • The diagram

   • Information about partner links

   • Information about imported documents

   • A list of all defined variables

   • Information about the process elements

   • Documentation created for the process elements

2. To customize a report so it includes all of the element properties, or to include only elements that have documentation, click the Customize Report button in the BPEL Diagram toolbar.

   A Customize Report dialog box appears.

   • Choose Generate Verbose Report to include all of the element properties in the report.

   • Choose Include Only Elements with Documentation to only include elements with documentation in the report.

3. Click OK, and click the Generate Report button. If a report already exists, the new report will overwrite the existing report in the Projects window.