Onsignal

Receives communications from other scripts.

Supported Script Types

Properties

Properties Details
SrcContactIDVar

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

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

When a URL or Web Service Signal message is received there is no contact IDClosed 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.

Branches

Branch Details

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 other branches are not defined.

Tips & Tricks

  • Onsignal is an event.
  • 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 Signal action, 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 is finished. Refer to Signal for more information.
  • 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 (web service initiated)