Skip to main content
Older versions of Internet Explorer will not support certain site features. Chrome, Safari, Firefox, and Edge will provide the best experience.
Spok

Upgrading to Spok Mobile 4.5 (Wireless Deployment)

This article describes how to upgrade to the Spok Mobile 4.5 Server environment wireless deployment.

You can implement Spok Mobile 4.5 using the Care Connect Suite installer. See Implementing Spok Mobile 4.5 for instructions on setting up a Care Connect and Spok Mobile server environment.

About the 4.4 and Newer Environment

Beginning with Spok Mobile 4.4, the Platform and Spok Mobile components reside on separate servers. A third server is typically required for the database, due to size constraints. While preparing for an upgrade, keep the following environment setup in mind:

  • The Care Connect Server hosts the Platform
  • The Spok Mobile Server hosts Spok Mobile services
  • The Database Server hosts the Database

Upgrading single-server environments prior to 4.4

If you are upgrading an existing environment that hosts the Platform and Spok Mobile on a single server, you will need to separate these components. For example, such an environment might originally be set up like this:

  • The original server hosts both Spok Mobile and Platform.
  • The original Database Server hosts both the Database for Spok Mobile (AmcomAmcPremiseCore) and the databases for the Platform (Meta and Core).

In this example, the Database server would be upgraded, but two new servers would need to be created:

  • A new Care Connect Server which will host the Care Connect Platform and other features.
  • A new Mobile Server which will host Spok Mobile.

In this situation, you should begin the upgrade process by shutting down the existing server and removing Spok Mobile/Platform from it.

If you are running Care Connect Web/Device Preferences 1.6 and Spok Mobile 4.2 or earlier, no upgrade path can preserve the databases of both systems. In this situation, both the Care Connect Web/Device Preferences and Spok Mobile are each running on their own server, and each server has its own instances of the Platform and database. Data from one set of databases cannot be migrated to the others.

To upgrade this kind of environment to Spok Mobile 4.5, keep and upgrade the existing Spok Mobile Database server. The Care Connect Web/Device Preferences database must be rebuilt.

Before You Begin

Perform these steps before you begin the upgrade process:

  • Download the CCS 1.9 installer and bootstrapper on both the Care Connect Platform Server and the Spok Mobile Server.
  • Prepare all required prerequisites on the Platform Server and the Spok Mobile Server, according to Spok Mobile and Care Connect documentation.
  • Configure the Asset Folder directory in a separate location on the Spok Mobile Server:
    • Copy the file upload folder content from the old server to the new location that resides on the Spok Mobile Server.
    • Configure the Asset Directory field. See Configuring System Settings.
  • Create and store a backup of the Web.config file of the AMC/Wctp service located at Local Disk (C:) > inetpub > wwwroot > AMC > Wctp. This step is necessary because the WCTP settings are not stored after the upgrade, and will need to be updated manually.

The procedure to upgrade from Spok Mobile 3.5 to 4.5 involves two stages:

  1. Upgrade the Database server to version 4.2.
  2. Install and configure the Care Connect (Platform) Server and Spok Mobile Servers for 1.9/4.5. Use the Care Connect Suite installer to perform the installations on the Care Connect, Spok Mobile, and database servers.

The old Spok Mobile Server and the 4.5 Spok Mobile Server have the same DNS name but different IP addresses. After the upgrade, the DNS will be updated to point to the IP address of the new server. If device requests to Spok Mobile fail, restart the Wi-Fi and the devices will reconnect.

Keep a Backup of the Existing Database

Before you begin the upgrade, make sure you have a backup of the existing database(s) and the certificate that will migrate with the databases to support the encryption.

Migrating a 4.0, 4.2, or 4.4 Database

Databases in SQL Server 2008 or 2012 must be migrated to SQL Server 2014 or 2016, which are compatible with Spok Mobile 4.5. If the database being upgraded is already on a Spok Mobile 4.5-compatible version of SQL Server, you might not need to migrate the database because the server will be reused in the upgraded environment. The following procedure aims to minimize downtime during upgrades that require a database migration. In steps 1 through 8 below, backups are created while services are still running.

  1. Locate the SQL Scripts. These are available with the CCS 1.9 installation media.
  2. Log into the existing SQL Server, on which the Spok Mobile database is deployed.
  3. If the SQL Server is running SQL Server Standard Edition, skip this step. If the SQL Server is running Enterprise Edition, execute 1_ExportCertificate.sql. This script will create the two certificates which will encrypt the Enterprise Edition SQL Server.  When the script has been executed successfully, it will provide instructions for which files need to be copied and moved to the other server.
  4. Execute 2_BackupDatabases.sql. When this script has been executed successfully, it will provide instructions about which files need to be copied and moved to the other server.
  5. Log in to the new SQL Server for the 1.9/4.5 environment (which should be running SQL Server 2014 or 2016).
  6. Copy the two certificates (if applicable) and the three backup files from steps 3 and 4 to the default SQL directory. If you do not know the location of the directory, run GetSQLServerDefaultBackupDir.sql to identify it.
    The following files will be transferred:
    • Spok_TDE_Certificate.cer (if Enterprise Edition)
    • Spok_TDE_Certificate_Key.pvk (if Enterprise Edition)
    • AmcomAmcPremiseCore.bak
    • AmcomCore.bak
    • AmcomMeta.bak
  7. If the SQL Server is running Standard Edition, skip this step. If the SQL Server is running Enterprise Edition, execute 3_ImportCertificate.sql.
  8. Execute 4_1_1_RestoreDatabases.sql.

    At this point in the procedure, you have completed a partial restore of the database. Most of data has been restored on the new server. However, the database is not fully operational yet. The database is currently in the "Restoring" state. Perform the following steps to complete the database restoration/migration.
  9. Log into the old 3.5, 4.0, 4.2, or 4.4 Application Server.
  10. Stop the following Windows services:
    1. Spok Mobile Adapter (if running)
    2. Spok Mobile Services
    3. Stop IIS services.
  11. Execute 4_1_2_BackupDatabasesDifferential.sql on the old database server. This backup will get any changes made between the time the backup was created in step 4, up to the moment when the services were stopped in step 9. Transfer the new backup files to the new Database server location.
  12. Execute 4_1_3_RestoreDatabasesDifferential.sql on the new Spok Mobile 4.5 SQL server.

Removing Existing Database Registrations: 4.5-Compatible Database Server

If the system that is being upgraded is version 4.x or greater and is being upgraded to a newer version, the customer’s existing registrations should be removed from the following tables in the existing AmcomAmcPremiseCore database (SQL Server|AmcomAmcPremiseCore|Tables) before upgrading the system:

  • Registrations (AmcomAmcPremiseCore.dbo.Registrations)
  • License (AmcomAmcPremiseCore.dbo.License)
  • REGISTRATION_FEATURE (AmcomAmcPremiseCore.dbo.REGISTRATION_FEATURE)
  • Devices (AmcomAmcPremiseCore.dbo.Devices)

These existing registrations should be removed because when upgrading, the migration in the installer checks the registrations and because the registrations are found in the old database but not in the new database (AmcomMeta database), they are migrated again, so these records re-appear in the Premise system.

Upgrading from 4.x to 4.5

To upgrade from Spok Mobile versions 4.0, 4.2, or 4.4 to version 4.5, use the Care Connect Suite installer.

In load-balanced environments, the backup server will be upgraded first.

Uninstalling Spok Mobile 3.5, 4.0, 4.2, or 4.4

  1. Log in to the existing Spok Mobile server.
  2. Stop Spok Mobile Windows services.
    clipboard_ef9b627306402934a037d2cc22a984bbe.png
  3. Open Program and Features.
  4. Right click on the Spok Mobile application and click Uninstall.
    clipboard_ec1d6d26a43987370a1705a36e7303a11.png
  5. When the Programs and Features dialog prompts you to confirm, click Yes to uninstall Spok Mobile.

Installing the Care Connect Server

For detailed procedures about how to install the Platform (and DPR/CCWeb, if applicable) on the Care Connect Server, see Implementing the Care Connect 1.9 Server..

The Care Connect Suite installer will not default to the previous Spok Mobile installation locations. If you need to install to a different location, select the desired install location the first time you run the Care Connect Suite installer. After the initial upgrade using the Care Connect Suite installer, future upgrades will preserve the installation locations. The standard Care Connect Suite installation locations are C:\Program Files\Spok, C:\inetpub\wwwroot\Spok, and C:\inetpub\wwwroot\AMC.

Updating the Configuration Service URL

You can use the Config Manager to update the Configuration Service URL. The Config Manager will automatically open in a web browser after the Care Connect Suite installer successfully installs any of the following features:

  • Platform: Web Site, Web Service, Adapter Service.
  • Mobile: Web Site, Web Services, Windows Services.

The Config Manager will also display when you log in to the Administrative interface. If IIS detects that a connection to the current configuration cannot be made, the Platform Server Name or IP page will display instead. You will need to enter a valid configuration service URL in order to continue to the Administrative pages.

If the Platform Server Name or IP page does not automatically display or if you need to access it to update the URL, you can access it at http://IP_ADDRESS/ConfigManager/

To update the Configuration Service URL, perform the following steps:

  1. Navigate to http://IP_ADDRESS/ConfigManager/ if this page does not automatically appear in a web browser (or you want to return to it).
  2. In the Platform Server Name or IP field, enter or edit the address of the Platform Config Service. Select https if needed.
    clipboard_ee0be86748d63456ec759158f045e8476.png
  3. Click Save.
    The system will test whether or not the server name or IP that you entered has been changed successfully. If the connection to the configuration service fails, check your server name or IP for errors and try again. You cannot proceed with the implementation without saving a valid configuration service URL.
  4. Before continuing with any configuration, restart IIS on all Care Connect Application and Platform servers.
    1. To restart IIS, open a new Command Prompt or PowerShell instance.
    2. Type iisreset, and press Enter.
    3. IIS will restart.
  5. Before continuing, repeat the IIS restart step above on all Care Connect Application and Platform servers.

Configuring the Care Connect Server

Before you begin the configuration, ensure that the SSL certificates have been imported to the Platform Server. You will not be able to configure HTTPS until the licenses are in place. For detailed information about configuring the Care Connect Server, see Configuring Required Care Connect Web/Device Preferences Settings.

  1. If you are using mirroring, set up a failover partner. For more information, see Setting up a High Availability Spok Mobile Environment.
  2. Log in to Platform Web.
  3. Navigate to the Administration > Edit Settings page (See Configuring System Settings).
  4. Under Web > IIS Configuration:
    1. Update the Server Name field from localhost to the host name of the Platform Server name.
    2. Select Enable HTTPS.
  5. Under Email > SMTP Settings, make sure the following fields are completed:
    1. Host
    2. Port
    3. SMTP From
  6. Under Assets > Assets, update the Asset Directory Location field to point to the shared Asset folder.
  7. Save your changes.
  8. The Platform Server Name or IP page will open. This page requires SMTP setting validation, so you should prepare the SMTP server before you finish this step.
    1. Select HTTPS.
    2. Fill in the Platform Server name.
    3. Click Save.

After you complete the upgrade, you will need to comment out some sections in the CoreService configuration file. Navigate to wwwroot\Spok\CoreService. Open the web.config file, navigate to the <gateways> section and comment out the following gateways:

  • AMC
  • Voice
  • AlphaNumeric

Installing the Spok Mobile Server

For more information about installing the Spok Mobil 4.5 server, see Implementing the Spok Mobile 4.5 Server.

The Care Connect Suite installer will not default to the previous Spok Mobile installation locations. If you need to install to a different location, select the desired install location the first time you run the Care Connect Suite installer. After the initial upgrade using the Care Connect Suite installer, future upgrades will preserve the installation locations. The standard Care Connect Suite installation locations are C:\Program Files\SpokC:\inetpub\wwwroot\Spok, and C:\inetpub\wwwroot\AMC.

If you install Spok Mobile 4.5 on a different server than the one on which it was previously installed, you will need to upload the license that was used for the previous Spok Mobile version again after installing 4.5.

You will also need to update the Configuration Service URL after the installation. For more information, see the section Updating the Configuration Service URL.

Configuring the Spok Mobile Server

Before you begin the configuration, ensure that the SSL certificates have been imported to the Spok Mobile Server. You will not be able to configure HTTPS until the SSL certificates are in place.

For more detailed information about configuring Spok Mobile, see Configuring Spok Mobile Settings and Devices.

  1. Log in to Spok Mobile Admin at the following URL: http://localhost/amc/admin.
  2. On the Edit Connection String page, enter a valid Username and Password for the SQL database, then click Test.
    clipboard_e17dc3fffc2f47c32f4e63a356a9f6812.png
  3. When the test passes, the Successful connection to database message displays. Click Save.
  4. Navigate to System Configuration > Mobile to view the Edit Mobile Configuration page.
    clipboard_e475616b90728f558c7836cd7de9c3612.png
  5. Change the Mobile Server Name field from localhost to the DNS name of the Spok Mobile Server.
  6. Check the box for HTTPS.
  7. Verify the information on the rest of the page.
  8. If you are using mirroring, enter the failover partner in the Secondary Server Name field. For more information, see Setting up a High Availability Spok Mobile Environment.
  9. Click Save and then click Apply.

The old Spok Mobile Server and the new Spok Mobile 4.5 Server will have the same DNS name but different IP addresses. After the upgrade, the DNS will be updated to point to the IP address of the new server. If devices have trouble connecting to Spok Mobile, restart the Wi-Fi and the devices will reconnect.

  1. Confirm that Windows Services are running and that the Windows Service log contains a HANDSHAKE ACCEPTED message. This means that Spok's Hosted server has accepted the connection request initiated by the Spok Mobile Service. If the log does not contain this message, you will need to start the service manually. Right-click on the service and select Start.  The HANDSHAKE ACCEPTED message will appear in the logs on the Mobile server in <install drive>\Program Files (x86)\Spok\Care Connect\Mobile Connect Services\logs\SM_CoreService.txt.

Details Specific to Wireless Upgrades

Before you upgrade the Wireless system to Spok Mobile 4.x, ensure that the APNS certificates are in the Message Broker folder. In most cases, this directory is located in the following location: Local Disk (C:) > inetpub > wwwroot > AMC > MessageBroker. This configuration is unique to the Wireless system, because it uses the premise system to send push notifications. 

After the upgrade is complete, you will need to update the WCTP configuration file. This file is normally located at Local Disk (C:) > inetpub > wwwroot > AMC > Wctp. Make a backup of the existing configuration before you update this file. Edit the newly deployed Web.config file and copy all <appSettings> from the backuped file to the new one.

Database Changes

After the upgrade is complete and you have set up your configuration, you will need to update several values in the AmcomAmcPremiseCore.dbo.CONFIGURATION_INFO table before the system will be fully functioning:

  • Update the configuration record Amcom.Premise.Push to True. This will allow the Delivered field of a Notification record to be updated.
  • Update the following Message Broker records to use the local MessageBroker service instead of the Hosted service:
    • NotificationWorker.Apple.MessageBrokerUri
    • NotificationWorker.Android.MessageBrokerUri
    • NotificationWorker.BIS.MessageBrokerUri

These records need to be pointed to https://{premise-domain-name}/AMC/MessageBroker/Messages. Do not set them to localhost.

After the above changes have been made to the Database, restart the IIS.