Skip to main content

Need Help Using Spok Knowledge?

Internet Explorer is not supported. Please reload in Chrome, Edge, Firefox, or Safari.
Spok

Spok Messenger Gateways: Script

Script gateways are used for sending and receiving messages from systems using the Script protocol.

General

The Script Gateways dialog can be displayed by choosing the Interfaces > Script > Gateways menu option.

Name

Refers to the name of the gateway. The name is displayed in the list on the left and Send via fields for contacts and gateways.

Gateway enabled

Enables or disables the gateway from running.

Messages sent to external equipment

Indicates gateway outputs messages and allows the gateway to be selected in the Send via fields for contacts and gateways.

Message received from external equipment

Indicates that the gateway that receives messages.

 

Gateway

Script is the script that handles the dispatch of messages to ports, or forwarding of messages from ports into the server. There are predefined scripts that handle most requirements when sending messages out.

Script

The script that handles the dispatch of messages to ports or forwarding of messages from ports into the server. There are predefined scripts that handle most requirements when sending messages out.

File name

The file name of the script file that is to be used for the gateway.

Max. msg. length

Used for truncating or splitting outgoing messages.

Split long messages

Enable splitting or truncating.

Allow alarm to be cleared by message receiver

When set, this option allows events to be cleared by the message receiver.

Send Via

For messages forwarded by the gateway to the server, this can be used to over-ride using local ID lookup and forwarding it directly to another gateway.

 

Port

Script is the script that handles the protocol implementation. A copy of this script is executed for each port that is defined. If a port is shared between gateways, only one instance of that port and script is executed.

Script

The script that handles the protocol implementation. A copy of this script is executed for each port that is defined. If a port is shared between gateways, only one instance of that port and script is executed.

Filename

The name of the script to run.

Ports

A list of ports assigned to this gateway.

 

 

CallPoint

CallPoints are normally used with events. This can also be used as a lookup table by the developer to cross reference a string identifier with a recipient or text.

For events, define an identifier and a recipient. Define the location and call type, but no recipient. The recipient of an alarm is determined by the manager.