Promote sharing information with other members of your development team by
annotating a process. When you document the functionality of a process, you can quickly
communicate how a process works or fits business requirements, and consequently speed up
application development and avoid unnecessary changes that might come from insufficient
understanding of a functionality.
For example, by analyzing annotations, new team
members can quickly understand why certain actions occur in a process.
In the navigation pane of Dev Studio, click Case types, and then click the case type that
you want to open.
On the Workflow tab, click Life
Hover over a process in a stage, and then click the Configure
On the toolbar, click the Add a flow shape icon, and then click
Double-click the Annotation shape, and then replace the default text with your notes or
Optional: To adjust the size of the Annotation shape to fit the text, resize the Annotation
Drag the Annotation shape to a different position on the canvas, based on the
functionality that you want to document.
Result: At run time, annotations have no effect on processing.For example: The following figure shows a process that includes an annotation. The annotation guides
developers to maintain existing business logic criteria for routing an assignment until the
end of a release. As a result, the annotation minimizes the risk of unintentional changes that
could impact business processes.