Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Annotating a process

Updated on March 29, 2022

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.
  1. In the navigation pane of Dev Studio, click Case types, and then click the case type that you want to open.
  2. On the Workflow tab, click Life cycle.
  3. Hover over a process in a stage, and then click the Configure process icon.
  4. On the toolbar, click the Add a flow shape icon, and then click Annotation.
  5. Double-click the Annotation shape, and then replace the default text with your notes or comments.
  6. Optional: To adjust the size of the Annotation shape to fit the text, resize the Annotation shape.
  7. Drag the Annotation shape to a different position on the canvas, based on the functionality that you want to document.
  8. Click Save.
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.
Annotation in a process
A sample process in a flow diagram with an annotation.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us