Onsignal

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

A satellite receiver dish.

Receives communications from other scripts.

Dependencies

Onsignal is an event action.
The Onsignal event is used to receive communications from other scripts.
The Onsignal event will interrupt any script that is currently processing when the message arrives, including messages initiated by a Signalaction, which sends a message to an Onsignal event and will interrupt a script’s flow.
Parameters that are passed from a Signal action will be received as SP1, SP2, ... SPn. You may need to carefully design the script so that the code can continue to execute once the Signal action is finished.
There can be only one Onsignal event in a script.
The Onsignal event is triggered by:
- An external Signal action.
- A Signal action from a URL.
- A web service.

Supported Script Types


Generic	Email	Chat	Phone	Voicemail	Work Item	SMS

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.
Source Contact ID Variable	The name of a variable to receive the source ID of the script that issued the Signal action. Usually, when an Onsignal event receives a Signal message from another script, the value in the Src Contact ID Var property will be the contact ID of the script that sent the Signal message. When a URL or Web Service Signal message is received there is no contact ID A unique numerical identifier assigned to each contact associated with the Web Service, therefore, the value in the Src Contact ID Var property will be 0 (zero).
Parameters	The parameter values that will pass to the receiving script.

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.

Source Contact ID Variable

The name of a variable to receive the source ID of the script that issued the Signal action.

Usually, when an Onsignal event receives a Signal message from another script, the value in the Src Contact ID Var property will be the contact ID of the script that sent the Signal message.

When a URL or Web Service Signal message is received there is no contact ID A unique numerical identifier assigned to each contact associated with the Web Service, therefore, the value in the Src Contact ID Var property will be 0 (zero).

Parameters

The parameter values that will pass to the receiving script.

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.