Integrating eNotify with Spok Go

Last updated
Save as PDF

This article describes how to integrate e.Notify with Spok Go. This includes configuring the on-premises gateway and e.Notify to communicate with each other and pass data to the cloud.

Before you Begin

Ensure e.Notify 7.1.2 or higher is used.
Ensure the customer has set up user accounts within Spok Go and e.Notify.

Create the e.Notify 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 e.Notify Integration

Access Spok Go to add a e.Notify integration.

In Spok Go, click Administration > Integrations and click the Connectors tab.
Click +Connector to add the e.Notify connector.

In the Connector Details section, enter the following:

Connector Name	Enter a name for the e.Notify connector.
Description	Enter a description for the e.Notify connector.
Type	Select e.Notify from the drop down.

Select the Gateway where the integration will be created.
Click Save to save the connector. The connector is enabled.
Click the connector in the list and click the Enabled Services tab.
Enable the WCTP Service by sliding the toggle.

Click +Instance and enter the following info for the connector:

Client Address	This is the server that is running the daemon that is sending the message. Use the IP Address from the SenderID obtained in Step 2: Configure the WCTP Out Settings WITHOUT ":<port>/WCTP".
Security Code	Use the password (not encrypted) obtained in Step 2: Configure the WCTP Out Settings.

If you need to edit or delete the WCTP instance, click the vertical ellipses button and select Edit or Delete.
Under Priority mapping from WCTP to Spok Go, select a Spok Go Notification Priority for each WCTP Priority.
After all changes are made, click Save.

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

Disable the Connector

If you need to disable the connector perform the following.

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

Delete the Connector

If you need to delete the connector perform the following.

Click the connector in the list.
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 the WCTP Out Settings in e.Notify

Determine the password you will use to secure WCTP communication. Record this password for later use when generating an encrypted password for the e.Notify configuration and for the securityCode in the Configure WCTP section.
Manage the certificate.
1. Export the public key of the certificate that was loaded on the gateway to enable HTTPS to a *.PEM format file.
2. Copy the *.PEM file that is created onto the e.Notify app server’s file system.
Sign in to the e.Notify app server as a Super User.
At the Linux command line, using the password from earlier, type /home/amcom/bin/encrypt.sh and press Enter. Enter the password. An encrypted password is displayed. Copy and paste the encrypted password into a text file for later use.
At the Linux command line, enter /home/amcom/bin/serviceMenu.sh
For more information on using the service Menu Tool, see the Using the Smart Suite Service Menu Tool document.
1. Add a wctp_in process, noting the instance number used.
2. Add a wctp_out process, noting the instance number used.
3. Exit the serviceMenu.
Open the /home/amcom/wctp_in.ini file in a text editor.
1. Locate the section corresponding to the wctp_in process that was created.
2. Add an unused, non-SSL port number as the NETWORK PORT NUMBER.
  For example: 8989
3. Save the file.
4. Restart the wctp_in service you just updated.
Open the /home/amcom/wctp_out.ini file in a text editor.
1. Locate the section corresponding to the wctp_out process that was created.
2. For the Password Field Name enter "securityCode". This is case sensitive.
3. For the SENDER ID field, enter the value using the following format:
  <IP address of the e.Notify application server>:<port>/WCTP
  
  Note that the <port> should match the port that you configured as the NETWORK PORT NUMBER earlier.
  For example: 192.0.1.43:8989/WCTP.
4. Save the <IP address or domain> portion of the SENDER ID for later use in the Configure WCTP section.
5. For the SENDER PASSWORD field, enter the encrypted password from earlier.
6. Change the FORMAT CALLBACK NUMBER from "T" to "F"
7. Update the CERTIFICATE FILE NAME with the full path, including file name, of the *.PEM file from earlier.
8. Ensure that the SSL PROTOCOL VERSION is TLS 1.2 or higher.
9. Save the file.
10. Restart the wctp_out service you just created.
Ensure that the Linux system’s firewall is configured to allow traffic into the <port> that was configured as the NETWORK PORT NUMBER:
firewall-cmd --zone=public --add-port=<port>/tcp --permanent
service firewalld restart

Step 4: Add Pagers/Devices In e.Notify for Spok Go Users

Within e.Notify, devices need to be created so they can be assigned by Spok Go automatically.

Sign in to Smart Center.
Click Setup > Pager Setup > Pager Models.
Click Enter to search for existing Pager Model entries.
Ensure that an "ALPHA" Pager Model record exists, or create one if needed.
Click Setup > Pager Setup> Pager RCC.
Click Esc to leave query mode.
For the RCC field, enter a name such as Spok_Go.
For the Connection type field, enter Network.
For the Server Name field, enter the FQDN or IP address of the load balancer for the on-premises gateway. (Do not include “https://” Protocol.)
For the Port number, enter 443.
For the Path, enter WCTP.
For the Protocol, enter HTTPS.
Click File > Save.
Close the window.
Click Setup > Pager Setup> Pager Class of Service.
Click Esc to leave query mode.
For the COS field, enter Spok_Go_WCTP (or the same value that was used to name Spok Go’s Pager Class of Service in Smart Center).
For the Protocol field, enter WCTP.
For the RCC field, enter the RCC name you entered above (Spok_Go).
For the Callback # field, enter 1.
For the Process ID, enter the instance ID for the daemon that was previously used.
Click File > Save. A warning displays.
Click OK on the warning and close the window
Click Setup > Configuration Setup > System Configuration.
Click Esc to leave query mode.

Enter the Key Value pair as follows:

Key	Value
INTEGRATION DEFAULT PAGER MODEL	ALPHA
INTEGRATION DEFAULT PAGER COS	SPOK_GO_WCTP
INTEGRATION DEFAULT STATUS CODE	2

Click File > Save
Close the window.

After these steps, when the following properties are true for a e.Notify user, a pager will be created with an order number that is 1 greater than the user’s current list of devices (ex: max+1) and assigned automatically for that user in the e.Notify system.

the user has been created in e.Notify
the user has a message ID assigned in e.Notify
the user is synced into Spok Go
the user has signed in to Spok Go for the first time

Optional Step: Associate Spok Go User IDs as pagers for e.Notify Users

These users will not have pager IDs auto-added. To manually add a pager ID to these users, see Manually Add Pager IDs below.

Manually Add Pager IDs (optional steps)

Use these steps to manually assign a pager ID to users who previously did not have one and that have not be synced to Spok Go.

Get the User ID from Spok Go.
1. Click the Administration icon .
2. Click the user account. An edit screen is displayed.
3. Click the Access and Identity tab.
4. View and copy the Spok ID.
In Smart Center, click Admin > Pager Admin > Pagers.
1. Click Esc to leave query mode.
2. For the Pager ID field, enter the user ID of the Spok Go user copied in step 1d.
3. For the COS field, enter Spok_Go_WCTP.
4. For the Model field, enter ALPHA.
5. Click File > Save.
6. Close the window.
In Smart Center, click Admin > Listings.
1. Click Esc to leave query mode.
2. For the First field, enter a first name.
3. For the Last field, enter a last name.
4. For the Messaging ID field, click F3 to allow the system to auto-assign the next available ID.
5. Click the Pagers tab at the bottom of the window.
6. For the Order field, enter the next available number (including 1 if this is the first pagable device for the user).
7. For the Pager ID field, enter the user ID of the Spok Go user copied in step 1d. 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”).
8. Click Save.
Click the Messaging tab at the bottom of the Listings form.
1. Change the status to 2.
2. Click Save.

Step 5: Send a Message to a Spok Go User

Login to e.Notify.
Use one of the following methods to send a message:
Create New Event
Select the individual(s) / Message Group(s) / OnCall Group(s) which is a Spok Go pageable endpoint
OR
Select Activate Existing Event with a Spok Go pageable endpoint
Enter the message and click Create and Activate new event.
Verify the user receives it on their Spok Go Device.
Open e.Notify.
Click on Recent Activations > In Progress.
Click on Procedure and Step to monitor those people who have been notified and for the responses.

WCTP Status

e.Notify to Spok Go supports 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.