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

Integrating MediCall with Spok Go

This article describes how integrate to MediCall with Spok Go using a WCTP connection.

 

Overview

You can integrate MediCall with Spok Go. The article below describes the steps to integrate an existing MediCall system.

Before you Begin

Before integrating MediCall do the following:

  • Ensure you have MediCall version 11.12 or higher.
  • The MediCall system must trust the certificate used with the On-Premises Gateway.

For detailed information about MediCall configuration and requirements for integration with Spok Go, see MediCall Integration with Spok Go.

Step 1: Build and Deploy the Gateway

Ensure the on-premises gateway is installed and configured. For more information see, Installing and Configuring the On-Premises Gateway.

 

Step 2: Create the MediCall Integration

  1. In Spok Go, click Administration > Integrations and click the Connectors tab.
    +_connector.PNG
  2. Click +Connector to add the MediCall connector.
  3. In the Connector Details section, enter the following:
    Connector Name Enter a name for the MediCall connector.
    Description Enter a description for the MediCall connector.
    Type Select MediCall from the drop down.
  4. Select the Gateway where the integration will be created.
  5. Click Save to save the connector. The connector is automatically enabled.
  6. Click the connector in the list and click the Enabled Services tab.
  7. Enable the WCTP Service by sliding the toggle.
  8. Click +Instance and enter the following info for the connector:
    Client Address

    Enter the domain of the MediCall server.

    Example: 127.0.0.1

    Security Code Enter the password of the Paging Vendor.
  9. If you need to edit or delete the WCTP instance, click the vertical ellipses button and select Edit or Delete.
  10. Under Priority mapping from WCTP to Spok Go, select a Spok Go Notification Priority for each WCTP Priority.
  11. After all changes are made, click Save.

For more information on protocol support for WCTP, see Spok Go WCTP Protocol Support.

 

Configure Data Exchange

  1. Click the connector in the list and click the Data Exchange tab.
  2. For Entity Imports select the following:
    1. In Select entities you want to import, click Select All or select the entities individually.
    2. In Select how you want to import that data, select either Manually or Schedule Job. If you select Schedule Job, enter the Start Date, Time, and Frequency.
    3. In Select where you want to import the file, enter the folder path in the SFTP server that is running on the gateway.
      Examples: connector1 or connectorname.
      This must be unique per connector and the path must not be reused.
  3. Enable Entity Exports and enter the URL of the console listener.
    Example: http://10.40.182.35/CSSAPILISTENER/medicallConsoleService/restService/processEvent adjust accordingly if HTTP or a non-standard port is being used.
    The Application Key section then becomes available.
  4. Under Application Key, click Generate Secret Key. Copy and Save this key. This key is only available during connector creation and will need to be recreated if lost. Use this key in the console integration to access the Spok Go public API. For information on where to enter this in the CCS consoles, see that product's integration documentation.
  5. Click Save to save all changes or Discard to discard changes.

Below is the order in which the import files will be imported:

  1. Departments
  2. Specialties
  3. Locations
  4. Roles
  5. Devices
  6. Users
  7. Forwarding Status
  8. Care Team Roles
  9. On-Call Groups
  10. On-Call Schedules
  11. Communication Groups

 

 

File Import Specifications

Ensure you followed the specifications for file upload outlined in the following guides. Note that certain versions of each Spok console support specific versions of the Upload spec. These are noted under each spec version.

 

Running the Import/Export 

Now that your Spok Exchange File connector is configured, you can use an SFTP client with the User Name and Password that were previously generated to upload files to the address of one of your Gateway’s VMs using the default port 22.

You can get data about the status of file uploads in the Job Monitor tab. See Job Monitor for details on this feature.

Click the vertical menu CC_kebab_icon.png next to the desired Spok Exchange File connector and select an option based on the action you need:

Run Import

For connectors using a schedule, this will run the job immediately instead of waiting for the normal scheduled import. For a connector where it is configured to be manually triggered, this is the only way to start a job.

Run Export This option is currently unavailable.
Delete

Deletes the selected connector.

To bulk delete multiple connectors, click the box next to the desired connectors, use the dropdown next to the select all box, and select Delete.

You can also delete a connector from the configuration tab for that connector.

An error displays if the delete fails.

 

 

 

 

 

 

Disable the Connector

If you need to disable the connector perform the following.

  1. Click the connector in the list.
  2. Click the slider to disable the connector.

Delete the Connector

If you need to delete the connector perform the following.

  1. Click the connector in the list.
  2. Click Delete this connector permanently. This will permanently delete the connector so be sure only to select this if the connector is not needed.

Step 3: Configure MediCall to Communicate with the On-Premises Gateway

Configure iNetPage Application

For detailed information about MediCall configuration and requirements for integration with Spok Go, see MediCall Integration with Spok Go.

  1. On the MediCall Suite Client, navigate to: C:\Spok\Console\INetPage.

  2. Edit the InetPage.INI file and at the bottom of the [Vendor#] list add a new Vendor.

iNetPage only registers a maximum of 10 vendors.

[Vendor<unique #>]
VendorName=<name> CORTEXT
     (“CORTEXT” must be added to VendorName in order to send “Security Code”)
VendorProtocol=WCTP
VendorAddress=https://<load balancer for the gateway>/wctp
VendorPort=443
VendorUrlSuffix=/wctp
VendorQueueId=%<unique id>
     (This will be the device type identifier used in MediCall)
VendorTimeInterval=1
TestPagerNumber=<Spok Go ID>
TestMessage=<page message>
TriesOnPrimaryQueue=<# of retries; default is 1>
AlternateQueueEnabled=FALSE
AlternateQueueId=
AlternateQueuePrefix=
OfflineAfterTimeoutInterval=30
UserId=http://<IP that hosts iNetPage>:8080
     (This will be the “WCTP Client Address” for the WCTP Connector)
Password=<“Security Code” for the WCTP Connector>
TrimCapCodeEnabled=FALSE
TrimCapCodeToLength=7
SendSnppQuitMessage=FALSE
SendSnppLogiMessage=FALSE
TestPagerId=<unique ID used to send test page request>
TestProfileId=<unique ID used to send test page request>
TestMessageId=INetPage
WctpRole=Enterprise
WctpAllowResponse=False

  1. Save and close InetPage.INI.

  2. InetPage.exe must be opened/restarted after changes to InetPage.INI. (Vendor will default to “Vendor1” in InetPage.INI)

Step 4 : Add User and Device in MediCall Console

  1. Get the User ID from Spok Go.
    1. Click the Administration icon CC_Admin_icon.png.
    2. Click the user account. An edit screen is displayed.
    3. Click the Access and Identity tab.
    4. View and copy the Spok ID.
  2. Login to MediCall Console (C:\Spok\Console\Console.exe).

  3. In the MediCall Directory tab, click Add from sidebar. Select profile ID and click Ok.

  4. Click Exit to return to MediCall Directory tab.

  5. Search for newly created user and click Frq from sidebar.

  6. In the Frq Numbers tab, click Add in sidebar.

  7. From Pagers list at bottom, double-click the QueueID/Description that matches VendorQueueId of the vendor added to iNetPage (i.e. %36).
  8. Enter the Spok Go ID obtained from step 1d above into Number field, then click Ok. Use the following format: “User_user ID”.
    Note that other Spok Go entities that can be messaged via WCTP include Care Team Roles (ex: “Role_role ID”) and Message Groups (ex: “Group_group ID”).

  9. In the Frq Numbers tab, select the added pager and click Pager from sidebar to set as default.

  10. Hold CTRL key and press corresponding F key to send page. Follow prompts and verify the message is received by Spok Go.

WCTP Status

When using MediCall's typical WCTP configuration, MediCall does not support the return of WCTP status info (ex: delivered or read). All that is returned to MediCall is the machine-level success or failure of each message with failed messages that include error statuses with error codes that are relevant to the reason for the error.

However, if MediCall's WCTP2Way application is implemented, then MediCall can support the receipt of Spok Go's machine-level responses for successful messages that include Delivered and Read. Failed messages return error statuses with error codes that are relevant to the reason for the error.