Skip to main content
Click here if you are having trouble viewing this site
Older versions of Internet Explorer will not support certain site features. Chrome, Safari, Firefox, and Edge will provide the best experience.
Resources
Spok

Configuring the Spok Exchange File Connector

  1. Last updated
  2. Save as PDF
This describes steps for creating and configuring the Spok Exchange File Connector.

Overview

The Spok Exchange File Connector allows Spok Go to receive data from outside sources and pass it on to the cloud.

Before you Begin

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.

 

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 Spok Exchange File Connector

  1. In Spok Go, click Administration > Integrations and click the Connectors tab.
  2. Click +Connector to add the Spok Exchange File connector.
  3. In the Connector Details section, enter the following:
    Connector Name Enter a name for the Spok Exchange File connector.
    Description Enter a description for the Spok Exchange File connector.
    Type Select Spok Exchange File from the drop down.
  4. Select the Gateway where the integration will be created.
  5. After all changes are made, click Save. The connector is automatically enabled.

Upon the creation of a connector for data integration in the Integrations sections of SpokGo, the Connector Name will become available as an External System for managing External IDs for all Directory entities and On-Call. Upon automated load of entities, with External IDs, the unique ID passed in the file (refer to User info specification) will be added to the record using the Connector Name defined by the user.

If additional External IDs need to be added to a user for additional integrations, these IDs should be passed in the file in the “Other Known IDs with Producer Codes” field. For a list of supported ID types for system integrations, refer to External_Systems_Supported_for_User_ID_Association_with_Spok_Go_User_Accounts

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.

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. Click Save to save all changes or Discard to discard changes.
  4. Click Connectors to return to the connector list.

 

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.