Begin

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

The starting point of a script. Every Studio script and subscript must have one Begin action.

Dependencies

  • Begin must be the first action in the script.
  • Every Studio script must have one Begin action. If a script has more than one Begin, the script may not work as intended.

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.

Application

This property is not used.

Parameters

Add a variable for each parameter that's passed to this script. Enter one variable per line in the editor window. Use meaningful variable names. Variable names do not have to match the name of the corresponding variable used in the source that passes the parameters.

Parameters can come from sources such as API calls or another script that spawned the current script. Parameters that are passed into a script appear in that script's trace output in the Begin action.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description

Default

Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.

Tips & Tricks

If your script randomly starts in the middle instead of where you expect it to, check for a second Begin action that may have accidentally been added. Scripts start at last Begin action that was added.