ANNOTATION

Allows you to add comments or other text that's visible on the script canvas. Annotation and the Note action both allow you to add comments to your script. The differences are:  The text of an Annotation is visible on the canvas, but the text of a Note action is not. You can connect Annotation to another action in the script. For example, if you're annotating the purpose of a specific action, you can connect Annotation to that action. The Note action cannot be connected to other actions. You can format the text in Annotation, but not the text of Note. You can make Annotation text bold, italics, or underlined and apply heading or body text styles.

Supported Script Types

Generic	Email	Chat	Phone	Voicemail	Work Item	SMS	Digital

Input Properties

These properties define data that the action uses when executing.

Property	Description
Add Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.
Comments	The text that's visible on the script canvas. You can enter the text in this field in the properties panel, or you can add it directly from the script.

Add and Customize Annotations

1. You can add an annotation to your script in several ways:

   • Right-click on the script canvas and click Text. The cursor changes to a cross and you can draw a rectangle on the canvas. When you release the cursor, the focus is on the ANNOTATION action rectangle so you can start typing immediately without additional clicks.
   • Press T on your keyboard to change the cursor so you can draw an ANNOTATION on the script canvas.
   • Click Text in the left icon menu. The cursor changes to a cross and you can draw the action on the script canvas.
   • Click Actions in the left icon menu, search for annotation, and drag it to the canvas.
2. Enter your text in the annotation space on the canvas.

3. Select text to apply formatting options using the menu at the top of the text field. You can: 

   • Apply heading styles or make the text body text.
   • Apply bold, italics, or underline. You can use standard keyboard shortcuts such as CTRL + b to apply this formatting.
4. Connect the ANNOTATION action to other actions in the script if you want to relate the note to a specific action or part of the script.

 

Script Example

The following image shows an expanded size of the annotation area, custom text within the area, and the connector that connects to an action. Typically a connector is used to show a relation between the comment and the connected action.