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: Generic

Generic Input Gateways

Generic Gateways allow Spok Messenger to dispatch messages based on freeform data received from third party equipment such as Fire Panels, and Control software. Each gateway may be configured to accept different types of data input.

Name

Refers to the name that this Generic Gateway appears under in the panel on the left of the window.

Watchdog time

Specifies the maximum allowable time between characters. At this timer, a message is sent to the maintenance recipient and all associated ports are reset. 

Reply on OK

Sets the character that should be sent upon receipt of a valid packet. If your interface only handles simplex (one way) communications, leave this field blank.

Reply on error

Sets the character that should be sent upon receipt of an error packet. If your interface only handles simplex (one way) communications, leave this field blank.

Ports

Refers to the physical connections that this gateway utilizes. To add, edit, or delete an existing port from this gateway, simply select the port and use the buttons to the right of the Ports panel. The following dialog displays:

 

If no ports appear in the port list, you need to configure a port to use the Generic protocol in the Interfaces > Ports screen. Please note that configuring multiple ports to one gateway has the effect of setting message reception identically for each port, and may be useful if more than one identical piece of equipment is being connected to Spok Messenger.

Gateway enabled

Determines whether the gateway is functional. This setting should be enabled to ensure normal operation of the Generic Gateway.

 

Adding a Generic Input Gateway

  1. Choose Interfaces > Generic > Generic In. The Generic Input Gateways dialog displays.
  2. Select the Generic In menu option. The Generic Input Gateways dialog displays.
  3. Enter information as desired.
  4. Click Save to save the changes.

Editing Generic Input Gateways

An existing generic gateway can be edited.

  1. Choose Interfaces > Generic > Generic In.
  2. Select the Generic In menu option. The Generic Input Gateways dialog displays.
  3. Select the gateway to be edited from the list on the left.
  4. Change the desired information.
  5. Click the Save button. The changes to the gateway are saved.

Deleting Generic Input Gateways

Existing generic gateways can be deleted.

  1. Choose Interfaces > Generic > Generic In.
  2. Select the Generic In menu option. The Generic Input Gateways dialog displays.
  3. Select the gateway to be deleted from the list.
  4. Click the Delete button or press the delete key on the keyboard. The gateway is deleted.

 

Generic Output Gateways

Generic Out Gateways are defined as destinations for sending messages to various systems for which specific gateways have not been defined. A single screen is provided to manage Generic Out Gateways. This screen may only be accessed using the Interfaces > Generic > Generic Out menu option.

 

In this example, there is only one Generic Out gateway currently registered called Austco PRI. All registered Generic Out gateways appear in the left panel of the screen.

Name

The name that appears in the Gateway port list.

Format String

A string that defines how a message is formatted for output.

 

You can have up to 240 characters, which may be:

  • A normal character, which is output in every message.
  • %[mod len]Field which inserts message information to a specific format.

 

Field (case sensitive) determines the data to be inserted:

%a - the message's target address.

%m - the message text is inserted.

%t - the type (1 for tone only, 2 numeric, 3 extended numeric, 4 alpha, 5 email) is inserted as a digit.

%p - the priority (0 for normal, 1 for priority).

%b - the beep code (A through J) is inserted as a character.

%s - the sequence number of the message from this gateway.

%u - the username that generated the message, otherwise "System"

 

  • mod allows padding

Space

Left padding with spaces

-

Right padding with spaces

0

Left padding with zeroes

 

  • Len is the total length of the field - if the data is longer than len, then no padding is inserted.
  • mod and len only apply to fields a, m, and s
    • For example: %06a with address 123 would output 000123, whereas %-6a would output 123 _ _ _
  • \n, \r, \t are (case sensitive) line feed, carriage return and tab, respectively.
  • \xnn inserts the byte defined by hex code nn.
  • \\ and \% insert the \ and % characters, respectively.

Port

Refers to the physical connection that this gateway utilizes. If no port appears in this list, you need to configure at least one port to use the Generic Out Protocol.

Port, Baud, Data, Parity and Stop

Set the characteristics of the connection.

Phone

Phone number for modem to dial.

Max Messages

The maximum number of messages that are allowed in the queue. Please note that the maximum value for this field is 200.

Max msg length

Determines the longest message that can be sent through this gateway. Messages that exceed this length is either truncated or split, depending on the Split long messages setting.

Split long messages

Causes messages longer than the maximum message length to be sent as separate sequential messages.

Gateway enabled

Determines whether or not the gateway is functional. It is convenient to disable this setting to temporarily stop messaging to the Generic Out device.

 

Adding Generic Output Gateways

New generic out gateways can be added.

  1. Choose Interfaces > Generic > Generic Out.
  2. Select the Generic Out option. The Generic Output Gateways dialog box displays.
  3. Click New.
  4. Enter the desired information. NOTE: If no ports appear in the port list, you need to configure a port to use the Generic Out protocol in the Interfaces > Ports screen.
  5. Click the Save button. The new gateway is committed to the database.

Editing Generic Output Gateways

An existing generic out gateway can be added.

  1. Choose Interfaces > Generic > Generic Out.
  2. Select the Generic Out option. The Generic Output Gateways dialog box displays.
  3. Select the gateway to be edited from the panel on the left. The pre-existing information is populated in the fields.
  4. Change the required parameters in the field.
  5. Click Save. The changes are committed to the database.

Deleting Generic Output Gateways

An existing generic out gateway can be deleted.

  1. Choose Interfaces > Generic > Generic Out.
  2. Select the Generic Out option. The Generic Output Gateways dialog box displays.
  3. Select the gateway to be deleted from the panel on the left. The pre-existing information is populated in the fields.
  4. Click the Delete button on the screen or click the delete key on the keyboard. A confirmation dialog displays.
  5. Click Yes to delete the gateway.