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: Remote Display

Remote Display Gateways are defined as destinations for sending messages to Remote Displays. A single screen is provided to manage Remote Display Gateways. This screen may only be accessed using the Interfaces > Remote Display option.

 

In this example, there is only one Remote Display gateway currently registered called Adaptive 1 Line Display. All registered Remote Display gateways appear in the left panel of the screen.

Name

The name that appears in the Gateway port list.

Default String

Identifies the data sent to a remote display when a message is sent.

Priority String

Identifies the data sent to a remote display when a priority message is sent.

Standby String

Identifies the data sent to a remote display when a display is to be cleared down.

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 Remote Display Protocol.

Baud

Sets the communication rate for serial communication.

Data

Sets the number of data bits for serial communication.

Parity

Sets the type of parity for serial communication.

Stop

Sets the number of stop bits for serial communication.

Cycle Time

The time to leave the message on the display. If Life Time is large enough, the message may be displayed more than once.

Life Time

The time for which the message remains alive. For alarm messages the message remains until a reset message is received. Check that the alarm is configured to send a reset message, otherwise the message remains indefinitely.

Max Msg Length

The length to truncate or split the received message.

Split long messages

Truncates or splits the message.

Gateway enabled

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

 

Strings

”Default String,” “Priority String,” and “Standby String” format data when sending message to a remote display or when clearing the display.

  • A normal character, which is be 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 (0 for tone only, 1 numeric, 2 alpha, 3 email etc.) 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 for left padding with spaces, - for right padding with spaces, 0 for 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.

 

Keywords

When a message is sent to a remote display, the message may contain 1 or more keywords that you wish substituted for other text. The Remote Displays Gateway Keywords screen allows you to identify a list of keywords and associated substitute text. The Remote Displays Gateway Keywords can be accessed when you click Keywords in the Remote Display Gateways dialog.

 

Adding Remote Display Gateways

A remote display gateway can be added.

  1. Choose Interfaces > Remote Display. The Remote Display dialog displays.
  2. Click New. The fields can be edited.
  3. Enter desired information for the new gateway into the fields.
  4. Click Save. The new gateway is saved to the system.

 

Editing Remote Display Gateways

An existing remote display gateway can be edited.

  1. Choose Interfaces > Remote Display. The Remote Display dialog displays.
  2. Select the gateway to be edited from the list. The fields populate with the information for that gateway.
  3. Edit desired information in the fields.
  4. Click Save. The changes to the gateway are saved.

 

Deleting Remote Display Gateways

An existing remote display gateway can be deleted.

  1. Choose Interfaces > Remote Display. The Remote Display dialog displays.
  2. Select the gateway to be deleted from the list. The information for that gateway displays in the fields.
  3. Click Delete. A confirmation dialog displays.
  4. Click Yes to delete the gateway.