Stop

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

Stops a script when it's no longer needed, such as after processing an event. It does not terminate a contact. The contact remains in the state it was in prior to the Stop action. The only way to release a Stop action is to trigger an event such as ONSIGNAL, ONANSWER, ONHOLD, ONDATA, or ONRELEASE.

Stop is commonly used as a placeholder for branching events when the script has stopped running logic. Do not use this action if you need to terminate the script.

Supported Script Types

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Generic

 Email Chat Phone Voicemail Work Item SMS Digital

Comparison of Similar Actions

The following actions have similar functions, but with some key differences: 

  • Discard : Terminates an email script.
  • End : Terminates a phone, voicemail, SMS, or digital script. Does not terminate a digital contact, but terminates contacts in scripts with other media types.
  • End a Contact: Terminates the active contact. Does not terminate the current script.
  • EndText: Terminates an SMS workflow that doesn't include a Regagent action (for digitalClosed Any channel, contact, or skill associated with Digital Experience (DX). channels only).
  • EndWi: Terminates a work item with a cause code. Does not terminate the current script.
  • Exit : Terminates a chat session and disconnects the chat contact.
  • Hangup : Terminates a phone script.
  • Return : Terminates a subscript and returns control to the originating script.

Do not use the Stop action to end a script. It does not terminate the script and leaves contacts running. This has a negative impact on the NiCE CXone servers.

Do not add the HANGUP action to an ONRELEASE script branch. HANGUP initiates an ONRELEASE event, so adding HANGUP to this branch may affect the termination of the script.

Properties

None

Branches

None