Using Notes

You can use Notes to keep a track of information about any flow, activity, or trigger. It helps you in keeping updates and important references, especially when the flow is very large and complex. In addition, this feature is available in the Error Handler tab.

Let us take an example of a Flogo app that invokes a REST service. You use the ReceiveHTTPMessage Trigger, and InvokeRESTService, LogMessage and Return Activities to create the app.

Here, you can add notes in the following manner:

  • Flow Note: This note gives information about the flow. In the above case, the Flow Note can be - "This app invokes a Rest service and generates a log message that shows the status of the invoked Rest service".

  • Trigger Note: This note is used to add information about the trigger. For the above example, add the Trigger Note that says - "This trigger listens to incoming REST requests".

  • Activity Note: This note displays information about the activity. For the above example, the note for InvokeRESTService Activity can be - "This Activity invokes an external service".

To view all the notes, click the icon on the right-hand sidebar.

Note:
  • Use the icon on the Activities and Triggers to add notes.

  • Use the icon next to the Error Handler tab to add a Flow Note.

  • In all cases, icon implies notes are not added and icon indicates that notes are added.

  • The Save option on any note is enabled only after some content is added in it.

  • If you are a read-only user, you cannot add, delete, or edit a note.