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

The MXPP gateway is used to send and receive messages from devices such as Spok Mobile devices. Through configured routes, the MXPP gateway can also establish a connection between the Spok Messenger system and the Fusion Event Management Module system by using an MXPP gateway in Messenger, and an MXPP gateway in the EMM with an IP port. The MXPP gateway in Spok Messenger can be accessed by choosing Interfaces > MXPP.

Please note that if an MXPP gateway is being used to establish a connection to the Fusion Event Management Module and the gateway that is being used on the Fusion EMM side is altered, the route name in Spok Messenger needs to be altered as well. If this is not done, the message status for these messages shows that the connection is unsuccessful because there is not a gateway saved under the referenced name.

When configuring devices to communicate through the MXPP gateway, enter the direct address for the contact (Example: Cisco would use the MAC address of the phone), choose the MXPP Out port, and then choose the correct route for the contact.

Name

In the Name field, enter the name of the gateway that you are creating.

Ports

In the Ports field, enter the ports that the gateway should listen on for logins and updates.

Gateway Enabled

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

No Response from device

The length of time the gateway should wait before it sends a notification of a device to the host system. The time is measured in seconds and the default time is 60. Please note that you can also enter a value of “-1” to turn off this notification.

No Response from user

The length of time the gateway should wait before it sends a notification of a user timeout to the host system. The time is measured in seconds and the default time is 600.

No activity on port

The time (in seconds) the system waits for no activity before disconnecting an idle port.

Output Enabled

When this is enabled, the gateway is used as an output gateway

URL

In the URL field, enter the IP address of the machine that you want to connect to.

Port

In the Port field, enter the port number through which you would like to establish a connection.

Output Message TimeOut (in minutes)

In the Output Message TimeOut (in minutes) field, enter the time in minutes for the MXPP outbound queue timer. This is utilized when outbound MXPP connections are severed.

Spok Mobile Enabled

Enable the Spok Mobile Enabled option if you would like to use the MXPP gateway to communicate with the Spok Mobile product.

Please note that if this option is enabled, the Output Enabled option also must be enabled to establish a connection to the Spok Mobile product. In addition, the Routes button is disabled when this option is enabled because routes cannot be used with the gateway if the gateway is setup to communicate with Spok Mobile.

For more detailed information on how to configure Spok Messenger to be used with Spok Mobile, please refer to the Configuration_Guide_Messenger_for_Spok Mobile document.

Registration URL

In the Registration URL field, enter the URL that is used for registering devices. Typically this would be “http://” then the IP address or fully qualified domain name of the Spok Mobile server. If the Spok Mobile server installation is on the same machine as Spok Messenger, you could use “local host”. After this, “/ClientRegistration” must be added to the end. For example: http://SpokMobile.Company.com/ClientRegistration.

Registration Port

In the Registration Port field, enter the port number through which registration is performed. Please note that this port must match the Message Download URL Port setup in the Spok Mobile Administration interface.

Site ID

In the Site ID field, enter the unique identifier for the server with the Spok Mobile Registration Service. Please note that you are assigned a site ID by a Spok staff member after purchasing the system.

Registration Form

In the Registration Form field, enter the stand alone registration form for the Spok Mobile Administration (http://core_url/AMC/RegistrationForm...c/Registration). Typically this would be “http://” then the IP address or fully qualified domain name of the com Spok Mobile server. If the Spok Mobile server installation is on the same machine as Spok Messenger, you could use “localhost”. After this “/Spok/RegistrationForm/” must be added to the end. For example: http://core_url/AMC/RegistrationForm...c/Registration.

Alert Profiles

The Alert Profiles button allows you to determine the priority settings for each alert profile. When the Alert Profiles button is clicked, the Configure Alert Profiles dialog displays.

 

Adding an MXPP Gateway

MXPP gateways can be added into the Spok Messenger system.

  1. Choose Interfaces > MXPP. The MXPP Gateways screen displays.
  2. Click New. The fields become editable.
  3. In the empty fields, enter the desired information. 

 

Configuring Routes

Routes in the MXPP gateway provide a means of communication between the Messenger MXPP gateway to the Fusion EMM system. Routes must be created for each outbound gateway in the Fusion Event Management Module that the user chooses to use for MXPP messaging. These names must match, with the exception of the case, because the names are not case sensitive. In addition, duplicate route names are not allowed.

Please note that routes cannot be used if the Spok Mobile Enabled option is enabled.

 

Adding Routes

Routes can be added into the MXPP gateway in the Messenger system.

  1. In the MXPP Gateways dialog, click Routes . The Edit routes for gateway dialog displays.

  1. Click Add. The Add a route to gateway dialog displays.
  2. In the Name field, enter a name to describe the route that is being created. Please note that this name must match the gateway name in the Fusion EMM of the outgoing port to be used to route the MXPP message. For example, if MXPP is to route to the EMM and send to a Cisco handset, the route here should match the gateway name for the Cisco gateway within the EMM.

  1. After the desired name is entered, click OK . The route is saved and displays in the Edit routes for gateway dialog.

 

Editing Routes

Routes can be edited in the MXPP gateway in the Messenger system.

  1. In the MXPP Gateways dialog, click Routes . The Edit routes for gateway dialog displays, showing any existing routes that have been added to the gateway.
  2. In the Edit routes for gateway dialog, choose the route that you would like to edit. The route becomes highlighted.
  3. Click Edit. The Edit route name for gateway dialog displays.
  4. Make any desired changes.
  5. After the desired changes are made, click OK . The changes are saved and display in the Edit routes for gateway dialog.

 

Deleting Routes

Routes can be deleted from the MXPP gateway in the Messenger system.

  1. In the MXPP Gateways dialog, click Routes . The Edit routes for gateway dialog displays, showing any existing routes that have been added to the gateway.
  2. From the list of routes that have been configured in the gateway, choose the route that you would like to delete. When the route is chosen, it becomes highlighted.
  3. When the route that you would like to delete is chosen, click Remove . A warning dialog displays.
  4. Click Yes. The route is deleted and is removed from the Edit routes for gateway dialog.

 

Configuring Alert Profiles

Alert profiles in the MXPP gateway dictate how the phone rings when messages that are sent through the MXPP gateway are received. For example, if you choose the Medium alert profile, the device sounds the ringtone and vibrate configurations that are set on the device when a message is received.

  1. In the MXPP Gateways dialog, click Alert Profiles . The Configure Alert Profiles dialog displays.

  1. Choose the desired alert profiles.
  2. After the desired changes are made, click OK . The changes are saved and you are returned to the MXPP Gateways dialog.
  3. Click Save to save the gateway.
  4. Click Close to close the dialog.

 

Editing an MXPP Gateway

An existing MXPP Gateway can be edited.

  1. Choose Interfaces > MXPP. The MXPP Gateways dialog displays.
  2. Select the gateway to be edited from the list on the left.
  3. Change the desired information.
  4. Click Save. The changes to the gateway are saved.

 

Deleting an MXPP Gateway

An existing MXPP Gateway can be deleted.

  1. Choose Interfaces > MXPP. The MXPP Gateways dialog displays.
  2. Select the gateway to be deleted from the list.
  3. Click Delete or press the delete key on the keyboard. The gateway is deleted.