[hfe_template id='1680'] Halo Integrator | HALO
Integrations
Start a Trial
Book Demo
Book Demo
Start Trial

Halo Integrator

Overview

The Halo Integrator is a separate application that executes scheduled integration imports. As new integrations are developed for the Halo Web Application, they become available in the Halo Integrator. Halo provides hosting for hosted customers only.

The Halo Integrator Module

Access the Halo Integrator module via Configuration > Integrations > Halo Integrator. Here you can:

  • Download the latest version
  • Configure an agent profile for integration operations (an API-only profile is recommended)
  • Generate a client secret
  • View enabled integrations

You can also monitor cloud hosted Halo Integrator logs in the backend service monitoring.

Setting Up an API-only Agent Profile

The Halo Integrator requires an Agent profile with Administrator access to execute synchronization processes. Create a dedicated "API-only" agent to ensure clear attribution of integration activities:

  1. Go to Configuration > Teams & Agents > Agents
  2. Click New
  3. Create a descriptive Username
  4. Assign an administrator-level role in Roles (e.g., "HaloITSM Administrator")
  5. Check Is an API-only Agent
  6. Click Save

Note for Hosted Customers

For Halo Software Llc hosted customers:

  • The client secret generated in Configuration > Integrations > Halo Integrator usually connects your Halo-cloud-hosted integrator
  • If so, generating a new secret will disconnect the current integrator
  • Contact Halo Support if you need to reconnect with a new secret

If you're using the web-hosted Halo Integrator, your setup is complete. For self-hosted installations, continue with the following instructions.

Hosting Your Own Halo Integrator

Organizations may need to host their own Halo Integrator in two scenarios:

  • When hosting their own Halo Web Application
  • When a hosted customer needs both:
    • Cloud-hosted integrator (for web-accessible applications)
    • Locally-hosted integrator (for locally-accessible applications)

For local hosting utilizing an API-application other than the default set in Configuration > Integrations > Halo Integrator, refer to the Creating a new application for API connections guide.

Installation Steps

  1. Download the Halo Integrator from Configuration > Integrations > Halo Integrator
  2. Extract the files to your chosen location
  3. Select and run either the standard or 64-bit executable

Configuring the Halo Integrator Windows Application

The Basic Configuration tab requires:

  • Halo URL: Your Agent URL
  • Client ID: Default value or from separate Halo application
  • Client Secret: From configuration or separate Halo application

Click Validate to test the connection, then Save to create appsettings.json.

Integrations Tab

Use the Integrations tab to select which integrations to sync. Note that integrations must be enabled both here and in Halo's configuration.

Processes Tab

The Processing tab manages integration runs. Click Start to process enabled integrations. Test manually before setting up recurring imports.

Setting Up a Recurring Sync

Create a scheduled task using Windows Task Scheduler:

  1. Open Task Scheduler and click Create Task...
  2. In Generaltab:
    • Name your task
    • Select Run whether user is logged on or not

  3. In Triggerstab:
    • Click New...
    • Set schedule (typically daily, outside working hours)
  4. In Actionstab:
    • Click New...
    • Set Action to Start a program
    • Set Program/script to Halo Integrator path
    • Add AUTO in Add arguments
    • Set Start in to Integrator directory

Available Integrations

Compatible integrations include a Halo Integrator section in their configuration screen with standard options:

  • Last Sync: Most recent successful run
  • Last Error: Most recent error (if any)
  • Integration-specific sync options

The above is taken from the new Azure Active Directory integration. The Last Sync and Last Error fields display the last successful run time of the corresponding integrations import, and the last error that occurred during that sync. In some integrations, you will also have the option to choose which imports are included when running the Halo Integrator, as shown above for Azure Active Directory.

When running a sync via the Halo Integrator, all active integrations that have been enabled will be included. You should therefore ensure that you only enable an integration for the Halo Integrator once you are happy with the configuration, to avoid any unsuspected outcomes. The entities to sync over can often be specified per integration.

Configuring Halo Integrator Agent Error Notifications

Released in Version: 2.100.1

Agents can receive notifications for Outgoing and Incoming Halo Integrator errors by using this setting located at Agent > Preferences > Notifications:

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

[hfe_template id='2416']
Linkedin-in Instagram Tiktok
Products
Company
Platform
Solutions
Resources
Sign up to the HALO Newsletter
© 2024 Halo Service Solutions. All Rights Reserved.