Documentation Window

Process Editorthen chooseSelect flow objectthen chooseDocumentation Window or

Process Editorthen chooseSelect processthen chooseDocumentation Window

Use to document the business process and BPMN flow objects.

You may use the documentation to communicate between process analysts and developers, and later on to guide the process users through the process. The documentation you write displays in HTML format, you can use the commands in this dialog to format the documentation according to your needs.

Type
Select a type of documentation. Available types are:

Language
Select the language to write the documentation. The available languages are the languages configured for the BPM project.

Undo icon
Click to revert the most recent action.

Redo icon
Click to re-apply a recent action that you reverted using the Undo icon.

Cut icon
Click to cut the selected text. You must select text before clicking this icon.

Copy icon
Click to copy the selected text. You must select text before clicking this icon.

Paste icon
Click to paste the text in the clipboard where the cursor is located.

Font Size
Select a font size for the selected text.

Font Style
Select a font style for the selected text.

Bold icon
Click to change the selected text to use bold.

Italic icon
Click to change the selected text to use italics.

Underline icon
Click to underline the selected text.

Foreground icon
Click to change the color of the selected text. If you do not select text it changes the default font color. When you click this icon, the Choose Color dialog appears. Select a color and click OK.

Left Justify
Click to left-justify the selected text.

Center Justify
Click to center-justify the selected text.

Right Justify
Click to right-justify the selected text.

Link
Click to add a link where the cursor is located.

Documentation Field
Enter a detailed description of the element you are documenting. You can use this description to communicate between process analysts and developers. You can also configure WorkSpace to display the process documentation once you deploy the application, this helps the process participant better understand how to run the process.


Modeling and Implementation Guide for Oracle BPM, "Documenting Your Process"