Using Notes

You can use notes to provide documentation directly in your EventFlow. A note icon on your EventFlow canvas has no effect on your application functionality, it just indicates the presence of information for the developer. Notes can be created either connected to a component, or freestanding.

  • To create a component-associated note, right-click the component and select Add Note. The note icon has a visible connection to the component.

  • To create a free-standing note, right-click in a blank area of the canvas and select Add Note.

To add text to a note, click the note to open its Properties view, and edit the fields in the General tab.

To see the contents of a note in the EventFlow, hover your cursor over its icon. As with other EventFlow components, the General tab's description text is displayed in a tooltip box.

General Tab

Name

Enter the note title that you want displayed in the EventFlow.

Description

Enter your text in the Description field. The field preserves line breaks, and can render the following HTML tags: b, p, and br.

See Also

The Notes and Groups sections of the EventFlow Editor page in the StreamBase Studio Reference.