Skip to content

Introduction

Halo Link is an server-based agent that connects a Practice Management System (PMS) to the Halo Connect cloud APIs. This allows PMS integrations to connect to your practice's PMS database via Halo's APIs, instead of installing their own agent directly on your server.

Halo Link should be installed on a practice server. Ideally on the same server as the PMS database, though there are options for installing it elsewhere.

Installing Halo Link should make no difference to practice staff, or require any changes to their workstations.

graph LR
    I1[Integration A]
    I2[Integration B]
    I3[Integration C]

    H1(Halo APIs)

    I1 <--> H1
    I2 <--> H1
    I3 <--> H1

    subgraph Practice
        subgraph PS [Practice server]
            S[(PMS DB)]
            H2(Halo Link agent)
            H2 <--> S
        end

        subgraph Practice staff
            U1[Staff computer]
            U2[Staff computer]
            U3[Staff computer]
        end
        PS <--> U1
        PS <--> U2
        PS <--> U3
    end
    H1 <--> H2
graph LR
    I1[Integration A]
    I2[Integration B]
    I3[Integration C]

    subgraph Practice
        subgraph PS [Practice server]
            S[(PMS DB)]

            A1[Integration A agent]
            A2[Integration B agent]
            A3[Integration C agent]

            A1 <--> S
            A2 <--> S
            A3 <--> S
        end

        subgraph Practice staff
            U1[Staff computer]
            U2[Staff computer]
            U3[Staff computer]
        end
        PS <--> U1
        PS <--> U2
        PS <--> U3
    end

    I1 <--> A1
    I2 <--> A2
    I3 <--> A3

Supported PMS

  • Bp Premier

Connecting integrations

Installing Halo Link does not mean integrations can automatically connect to your practice. To connect, they need:

  1. You to enable the integration in the PMS software per usual processes.
  2. You to give the integrator your PMS Site ID, so they can trade it for a Halo GUID.

Halo "Sites"

Halo defines a "site" as a server or virtual machine which has Halo Link installed. Some practices run multiple servers which Halo counts as multiple sites.

See Running mutliple servers for more information on how Halo Link manages this.

Halo GUIDs

A Halo GUID uniquely identifies a Halo Link installation and the server it is running on. It is what integrations use to talk to your practice's server -- like an address, or a username.

A practice may have multiple Halo GUIDs if it is running multiple servers or does a server migration. It is not the same as any identifier given to you by a PMS vendor or an integrator.

Integrators do not need to request your Halo GUID in order to connect to your practice's server. They can trade your PMS Site ID for your Halo GUID via our APIs.

Retrieving a Halo GUID

Halo Connect Support may occasionally request your Halo GUID for troubleshooting purposes. It can be found in the Halo Link registry and logs:

  • The Halo Link registry can be found in the Registry Editor at Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Halo Connect\Halo Link.
  • More information about logs is available in the Support docs.

Because a Halo GUID is unique to a server, if your site runs multiple servers, you will have multiple Halo GUIDs linked to your site in Halo Connect's system.

However, Halo Connect only supports PMS integrations contacting one server for each site, to avoid data corruption and desynchronisation. So we needed a way to specify which server integrations should contact.

Authoritative vs non-authoritative servers

Note

To change the authoritative server for your site, please contact Support.

  • An authoritative server is the main server for a site that integrations are allowed to talk to.
  • Non-authoritative servers are secondary servers which integrations can not talk to. These can include backup, testing, migration servers.

The first server Halo Link is installed on for a new site will automatically be set as authoritative. Subsequent installations on other servers will automatically be set as non-authoritative.

During installation, Halo Link will log whether a server is authoritative or not.


Next: Halo Link Installation