ANNOTATION

This help page is for Studio. This information is also available for Desktop Studio.

A capital T.

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 text of a Note action is not visible on the canvas. Additionally, 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.

Supported Script Types

A square with a line branching from it that goes to three other squares.

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 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 A stylized capital T. in the left icon menu. The cursor changes to a cross and you can draw the action on the script canvas.
    • Click Actions A square, triangle, and circle layered that overlap. 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. 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.

Image of a script that includes the ANNOTATION action.