HaloCRM

HaloCRM Guides

Guides > Halo Integrator

Halo Integrator

In this guide we will cover:

- What is the Halo Integrator?

- Do I need to Host my own Integrator?

- Types of Halo Integrator

- Hosted Halo Integrator

- Locally Hosted Integrator

- DB Halo Integrator

- Configuring Halo Integrator Agent Error Notifications - Hosted Halo Integrator only



What is the Halo Integrator?

The Halo integrator is an application that executes scheduled integration imports. Typically to import data from other tools into your Halo instance on a regular basis. As new integrations are developed for the Halo Web Application, they become available in the Halo Integrator. The Halo Integrator can only be used to sync data from compatible tools that have a native integration with Halo. It cannot be used to sync data obtained via a custom integration or third party integration.  


The Halo integrator can either be hosted by us (Halo) or you can host this application yourself. The setup and use of the Halo integrator will differ depending on who is hosting the integrator for your instance. 


Using the Halo Integrator that is hosted by us requires no setup and is easy to use/enable for your chosen integrations. 


Hosting your own Halo Integrator requires additional setup and more steps are involved when enabling the integrator for your chosen integrations. 


Do I need to Host my own Integrator?

Any customers who host their own Halo Instance (on-premise) will need to host their own Halo Integrator as we do not have access to the instance database.


Any customers who have their Halo instance hosted by us will also have access to the Halo Integrator hosted by us automatically. But whether you need to host your own Integrator will depend on the integrations you are looking to sync. 

  • Any on-premise integrations/tools will require you to host your own Halo Integrator in order to sync data on a schedule.
  • Cloud (web) hosted integrations can be synced with your instance using the 'Hosted Halo Integrator'. 


Customers who have their Halo instance hosted by us may also choose to host your own Halo Integrator if you would like to change the schedule of the sync. 


Types of Halo Integrator

There are three 'types' of Integrator we will reference throughout  this guide. Although the Halo Integrator is a single application, we will refer to the way in which it is used as it's own type, as setup and functionality will differ based on this. Types of Halo integrator include:

  • Hosted Integrator
  • Locally hosted Halo Integrator
  • DB Halo Integrator


Hosted Integrator = The Halo Integrator hosted by Halo. 

Locally Hosted Integrator = The Halo Integrator hosted by you. Hosted customers only.  

DB Halo Integrator = The Halo Integrator hosted by you, used exclusively by customers who host their own Halo instance.


Although we have outlined different 'types' of Halo Integrator here, all are referenced throughout the Halo web application simply as the 'Halo Integrator'. 


Hosted Halo Integrator

The Hosted Halo Integrator requires no setup as this is all completed by us at Halo.


Enable the Halo Integrator for an integration

Enabling the Halo Integrator for an integration will result in data syncing from the tool into Halo on a scheduled basis. 


The Hosted Halo Integrator is enabled per integration. Simply head to the integration module and check the option to "Enable the Halo Integrator for INTEGRATION X", as shown in figure 1. 

Fig 1. Enable the Halo Integrator for the Microsoft Entra ID integration


Some integrations will also allow you to choose which data/entities to import from the integration, rather than importing all available data. If an integration does not have this option available it cannot have data synced using the Halo integrator. 


You will not be able to choose the frequency that data is synced for integrations that use the Hosted Halo Integrator. 


Large syncs are usually scheduled to take place out of hours. If you would like to change the time at which a sync takes place (for a chosen integration) contact Halo support (support@halopsa.com/support@haloitsm.com) to request this. 


See which Integrations the Halo Integrator is Enabled for

To view which integrations have the (Hosted) Halo Integrator enabled head to Configuration > Integrations > Halo Integrator. Here, the section "Active Integrations" will show a list of integrations that have the Halo Integrator enabled. 

Fig 2. Integrations enabled for the Halo Integrator 


Note: Any integrations that are synced using the Locally Hosted Integrator will not show here. 


Other options on this page relate to the Locally Hosted Halo Integrator. 


Check Sync Schedule 

To see when each integration is due to be synced using the Halo integrator, head to Configuration > Integrations > Halo Integrator > Hosted Integrator Schedule. 

Fig 3. Hosted Integrator schedule


Check Halo Integrator Logs

A log for each run of the Hosted Halo Integrator will be stored and visible from your Halo instance. 


To view the logs head to Configuration > Integrations > Halo Integrator > Backend Service Monitoring > Halo Integrator log tab. 

Fig 4. Halo Integrator Logs


Here each log can be clicked into to obtain further information on the run. Used for troubleshooting. 


For more information on using and interpreting the logs here checkout Backend Services Monitoring.


Locally Hosted Integrator

The locally hosted integrator is used in the following circumstances:

  • You would like to sync data from a locally hosted tool (integration) with your Halo (such as Active Directory and Lansweeper).
  • You would like to sync data from a web (cloud) hosted tool more frequently than the hosted Halo Integrator. 


Setting up the Locally Hosted Integrator 

To use the locally hosted integrator you must first install the Halo Integrator application and connect this to your Halo instance. For information on how to do this please see the dedicated guide on the Locally hosted Halo Integrator here.


DB Halo Integrator

The Halo DB Integrator is used in the following circumstances:

  • You are hosting your own Halo instance and would like to import data from another tool into your instance on a recurring schedule.

The DB Halo Integrator is a different application to the Locally Hosted Integrator due to the way it retrieves and processes data. Whilst the standard Halo Integrator connects to the Halo API which accesses the database, the Halo DB Integrator has the Halo API built into it and connects directly to the Halo database.


The DB integrator is only available to on-premise clients as part of the WebbApp folder. 


Setting up the DB Halo Integrator

For information on setting up and using the DB Halo Integrator checkout Halo DB Integrator. 


Configuring Halo Integrator Agent Error Notifications - Hosted Halo Integrator only

Available from v2.100.1 +.


Agents can receive notifications for Outgoing and Incoming Halo Integrator errors by using the settings highlighted in figure 5. These are located under Agent > Preferences > Notifications.

Fig 5. Enable error notifications for the Halo Integrator


This will only alert you to errors found in the Halo Integrator hosted by us. Errors found in the Locally Hosted or DB Integrator will need to be monitored manually. 


These email notifications will be sent from notifications@haloservicedesk.com.



Popular Guides

Pin It on Pinterest