Skip to main content


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

Annotating a flow

Updated on November 22, 2021

You can use the Annotation shape to add notes and comments to your flow. By documenting the functionality of a flow, you can share information with other developers.

  1. In the navigation pane of App 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. Click the Flow shapes icon, and then click Annotation.
  5. Double-click the Annotation shape.
  6. Replace the default text with your notes or comments.
  7. Resize the Annotation shape to fit the text.
  8. Drag the Annotation shape to a different position on the canvas, based on the functionality that you are documenting.
  9. Click Save.
Result:

At run time, annotations do not have any affect on flow processing.

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us