Add a note to a dialog, trigger, or action
APPLIES TO: Composer v2.x
Composer users can now add notes to triggers, activities, and dialogs in their bot projects. Notes make it easy to add and display important and clarifying information about different aspects of your Composer bot logic, and let you add documentation to various bot components.
This article shows you how to add, edit or delete, and display notes in Composer.
- A basic bot built using Composer.
- Familiarity with dialogs, triggers, and activities.
Notes can be added to dialogs, triggers, and actions in your bot. To add a note, complete the following steps:
Open a bot in Composer. Then select the dialog, trigger, or action you want to add a note to. Composer displays the properties pane.
Underneath the description of the dialog, trigger, or action will appear the Add a note box. Add text to the box. Once the control loses focus, the note is added. The example below is of a note added to an Unknown intent trigger.
When you add a note to an activity, the note icon will appear next to the activity in the authoring canvas. See the section displaying note for more information about interacting with notes in the authoring canvas.
To edit or delete a note, do the following:
- Open a bot in Composer. Then select the dialog, trigger, or action with the note you want to edit or delete.
- Select the button with three dots on the top-right of the note box. Then select Edit or Delete. Selecting Edit will reopen the note for editing, and Delete will automatically delete the note.
You can display notes for activities in the authoring canvas. After adding a note to an activity, the note icon will appear next to the activity in the authoring canvas. Hover over the note to see the note's text, as shown below:
To view the note in the authoring canvas, select the note icon ( ) in the authoring canvas, above the Zoom in icon:
Your note will now appear on the authoring canvas, as shown below:
To hide the note, select the note icon again. You'll notice it appears with a slash through it when notes are displayed on the authoring canvas.