The BPEL Designer has a feature that allows to create comments (documentation) attached to the elements of the BPEL Process. This documentation will be included in the source code of the BPEL process and later can be extracted and included in a report.
To create documentation:
To read documentation:
A small book icon near the element that is not selected indicates that the element has documentation . If you point at this icon with the cursor, a tool tip with the text written for the element will pop up.
You can also see element's documentation in Documentation field of the Properties window.
To get all the documentation of the process as a separate file you can generate a report.
Report Generation feature of the BPEL Designer enables to generate a .pdf document describing the BPEL Process.
To generate a report:
On the BPEL diagram toolbar press the Generate Report button.
In the Projects window among the Process files of the BPEL module a pdf file will appear. The report in pdf format contains the name of the process, the diagram, information about imported documents, information about partner links, a list of all variables defined in the process and information about process elements. If the elements have documentation written for them, it will be included in the report.You can customise the report using Customise Report button on the diagram toolbar. This button provides two options: