Editing Spok Mobile Configuration Settings
Configuration information for Spok Mobile devices can be edited in the Edit Mobile Configuration page. The configuration information that can be altered includes: System, Database, Messenger, and Adapter information.
After any changes are made in the Edit Mobile Configuration page, the changes should be saved. In order for the changes to be saved, you must click Save . When the Save button is clicked, the changes are saved in the interface. However, when the Save button is clicked in the Edit Mobile Configuration page, the changes are not applied to the server. In order for the changes to be applied to the server, you must click Apply . When the Apply button is clicked, the changes that were saved when you clicked the Save button are applied to the server. Please note that when the Apply button is clicked in the Edit Mobile Configuration page, the server begins a brief outage in order to apply the changes to the server. Therefore, when the Apply button is clicked, a planned outage occurs.
Please note that after new information is added or existing information is updated, the information must be re-saved and re-applied in order for the changes to be applied.
NOTE: When configuring the Spok Mobile server, the server should never use a dynamic host configuration protocol (DHCP) for an IP address assignment.
Prerequisites
Be sure you have followed the steps in these documents before editing Spok Mobile configuration settings:
- Pre-Implementation_Guide_Spok_Mobile
- Implementation_Guide_Spok_Mobile_Services
- In the Spok Hosted Administration interface, choose the Administration|System Configuration|Mobile menu option. The Edit Mobile Configuration screen displays.
Server Settings Section
- In the Message Delivery drop-down menu, either the Local or Hosted optiondisplays. The option that is chosen in the Message Delivery section is automatically populated based on the option that is chosen during the installation process. This value should not be changed.
- Local: Local message delivery is required for client initiated messaging, the remote wipe functionality, and device preference settings. Messages are downloaded from the onsite Spok Mobile server so messages never leave the local site. Please note that when the Local Message Delivery option is chosen, the Asset Directory Location field displays.
- Hosted: With this option, all messages are sent to Spok Mobile hosted outside of the device’s local network for message downloading. Please note that the following features are not available with hosted message delivery: client initiated messaging, remote message wipe, device group configuration, and device preference configuration.
- In the Hosted Server Name field, the name of the hosted server being used displays. Please note that this field should not be altered from its default configuration unless directed to do so by a Spok employee.
- In the Mobile Server Name field, enter the externally and internally available name of the server that the Spok Mobile devices use to download Spok Mobile messages. In configurations that are load balanced, this value is the DNS name of the load balancer.
The information that is entered in this field must match the web Server Name field that is located in the Edit Settings screen. This screen can be accessed by choosing the Administration|System Configuration|Settings menu option. Please note that if this field is edited, the information in the Server Name field in the Edit Settings screen is automatically updated if the changes are saved.
If the Local Message Delivery option is chosen and the Spok Mobile Server is using a different URL to allow devices to download messages, then the fully qualified domain name can be entered. In this case, use the server name and domain name used on the public internet to access the server. If this is not done, local message delivery does not work. Please note that the network address translation is permitted to be able to map the server and domain name to the internal server running Spok Mobile.
- In the Port field, enter the number for the standard port that is used for communication between Spok Mobile enabled devices and the Spok Mobile Server. Please note that in most cases, the default port number of 8090 should not be altered unless specifically requested to do so.
- Enable the HTTPS option if you would like to use secure communication between the Spok Mobile devices and the Spok Mobile Server.
- Enabled: When the HTTPS option is enabled, the Spok Mobile devices have the ability to connect to the Spok Mobile Server over an HTTPS connection. If you choose this option, an SSL certificate that is applied to IIS must be installed. When this option is enabled, a warning dialog displays to notify users that even if the option is enabled, the configuration does not apply to Cisco devices or configurations. In addition, the SSL Port field and the Certificate Name field display when this option is chosen.
- Disabled: When the HTTPS option is disabled, the Spok Mobile devices do not have the ability to connect to the Spok Mobile Server over an HTTPS connection.
- In the SSL Port field, enter the port number for the standard port that is used for encrypted communication between Spok Mobile enabled devices and the Spok Mobile Server. Please note that in most cases, the default port number of 8091 should not be altered.
Please note that the HTTPS option must be chosen for this option to display.
For detailed information on the use of SSL certificates with Spok Mobile, please refer to the Implementation_Guide_Spok_Mobile_Services document.
- From the Certificate Name drop-down menu, choose the name of the SSL certificate for the server that you are using. All available installed certificates display in this drop-down menu.
Please note that the HTTPS option must be chosen for this option to display.
- In the Asset Directory Location field, enter the path to your Spok Mobile server. Spok Mobile users can send attachments to other Spok Mobile users, and the location specified in this field is where those attachments (such as images and videos) will be stored. Please note that this field only displays if the Local option is selected from the Message Delivery drop-down menu.
- Enable the Create Asset Directory if not found option if the specified location does not exist and a new folder needs to be created.
- In the gateway list table, add gateways as needed. The gateway list table is used for setting up the connection between the Spok Mobile server and the host system.
Adding Gateways
Gateways can be added into the Spok Mobile configuration in the Edit Mobile Configuration screen.
- Scroll down to the Gateway list table in the Server Settings section.
- In the Gateway list section, click Add . The Port and the Description fields can be edited.
- In the Port field, enter the inbound port number that connects the host system you are using to Spok Mobile. Please note that any number between 1024 and 65535 can be used, as long as the port numbers match for the host system and Spok Mobile.
- In Microsoft Windows, the chosen port must have all firewall restrictions removed in order for the port to be used.
- In the Description field, enter any clarification information you would like included with the entered port number. For example, if you entered port 20000 and 20001, you could clarify which of the ports is the primary port and which of the ports is the secondary port to prevent confusion. To add the new gateway, click Update . The gateway is added to the list.
Editing Gateways
Existing gateways in the system can be edited.
- Scroll down to the Gateway list table in the Server Settings section.
- Click on the gateway you would like to edit. The fields become editable and an Update button displays next to the gateway fields.
- Edit the desired information.
- Click Update next to the edited gateway.
Deleting Gateways
Existing gateways can be removed from the system.
- Scroll down to the Gateway list table in the Server Settings section.
- Next to the gateway you would like to remove, click Delete . A confirmationdialog displays.
- Click Yes to remove the gateway. The gateway is removed from the list.
Database Section
The Database section allows you to establish a connection to the Database server.
- In the Primary Server Name field, enter the fully-qualified domain name or IP address of the database server. In addition, enter the SQL Server instance name on the end of the server name. For example:
- With an Instance: <SERVER NAME>\<INSTANCE NAME>
- Without an Instance: <SERVER NAME>
- In the Secondary Server Name field, enter a fully-qualified domain name or IP address of the database service that should be used as a backup to the server entered in the Primary Server Name field. Please note that entering information in this field is only required if you are using mirroring.
- In the Username field, enter the username to be used to connect to the database. Please note that this field should be left as the default value.
- In the Password field, enter the password to be used to connect to the database.
- After filling in the fields, click the Test link on the far right to confirm that your database information is correct.
If the entered information is correct, the following dialog displays:
If the entered information is incorrect, the following dialog displays:
Messenger Section
The Messenger section allows you to establish a connection to a Spok Messenger system.
- Check the Enabled option to enable a connection to Messenger for supporting SMS Poke notifications.
- In the Server Name field, enter the fully qualified domain name or IP address of where Messenger is installed.
- In the Port field, enter the number for the Spok Mobile port that Messenger uses to listen for push notifications. The default installation uses port number 10001. However, in some cases, multiple ports are available because multiple applications connect to Messenger. For more detailed information on what port number to add, please refer to the Admin_Guide_Spok_Messenger document.
Please note that based on configuration, this port may need to be opened in a firewall setting.
Adapter Section
The Adapter section allows you to establish a connection to a Spok Care Connect system when Care Connect is configured to require authentication. Please note that before the Adapter can be enabled, the Apply link must be clicked.
- Enable the Enabled option if you would like to start the Adapter Windows Service. The Adapter Windows Service allows connections from Care Connect to connect to Spok Mobile Services. Therefore, when the Enabled option is enabled, a connection between Care Connect and Spok Mobile Services can be established through the Adapter Windows Service. Please note that connecting to a Care Connect system is not required if you do not have a Care Connect system.
- In the Listener Port field, enter the port number through which Care Connect connects to the Adapter Windows Service.
- Enable the HTTPS option if you would like the communication through the listener port to be encrypted with an SSL certificate.
For detailed information on the use of SSL certificates with Spok Mobile, please refer to the Implementation_Guide_Spok_Mobile_Services document.
- From the Gateway Port drop-down menu, choose the gateway port number through which the Adapter Windows Service connects to Spok Mobile. Please note that the gateway ports that display in the Gateway Port drop-down menu are configured in the Gateway List table in the System section above.
- In the Authentication table, add any necessary systems.
Adding Systems
A Care Connect system can be added into the Edit Mobile Configuration screen.
- Click Add. The fields become available for editing.
- In the System Name field, enter the name that is assigned to the Care Connect system to which you are connecting.
- In the Username field, enter the username that is used to sign into the Care Connect system to which you are connecting.
- In the Password field, enter the password that is linked to the username for the Care Connect system to which you are connecting.
- Click the Update link.
Editing Systems
Existing systems that are currently being managed in the Spok Hosted Administration system can be edited.
- Click in the field you would like to edit. The fields become available for editing.
- Change the desired information.
- After all of the desired information is edited, click the Update link. The information is updated.
Deleting Systems
Existing systems that are currently being managed in the Edit Mobile Configuration screen can be deleted from the system.
- In the Authentication table, next to the system you would like to delete, click the Delete link. A warning dialog displays.
- Click Yes. The system is deleted.
- When all of the desired information in the Edit Mobile Configuration page is added or edited, click Save in the upper right-hand corner. The information is saved.
- Click Apply button to apply the changes. Please note that before the Apply is clicked, all proper steps to prepare for an outage should be taken.