The following delineates the configuration that must be carried out in Halo in order to get Halo Integrator functioning correctly.
What is Halo Integrator
The Halo Integrator is a separate Windows application to the Halo Web application. It is used to run integration imports on a recurring schedule. New integrations will continue to be added as they are developed and added to the Halo Web Application.
The Halo Integrator module can be found under Configuration > Integrations > Halo Integrator. Click into the module to begin configuring it.
The Halo Integrator application corresponding to your current version of the Web Application can be downloaded using the link provided. It should be noted that the Halo Integrator will not be updated when your Web Application is updated, and the new file should be downloaded and manually copied over the old file to perform an upgrade, should you find the need to upgrade it.
The module contains a limited number of configuration options. Under the Setup heading, you will notice that an API URL and Auth URL are shown, along with a tenant value if you have one (this applies to customers who have their solution hosted by Halo). These two values will need to be added to the Halo Integrator when we begin configuring it.
You should also generate a new Client Secret which will also need to be copied into the Integrator application shortly. This value must be noted, as it cannot be retrieved once you navigate away from the page. Finally, an Agent must be chosen that the Halo Integrator will use to communicate with the Halo API. This Agent should have administrator permissions, otherwise certain required resources for the integrator may not be available, and import routines may fail.
Any integration that is compatible with the Halo Integrator will have a Halo Integrator section on the configuration screen. The layout of this section is consistent through all integrations. An option to enable the integration in the integrator is available, which when enabled, will reveal some additional 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 (if there was one). 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.
When opening the Halo Integrator, you will land on the configuration tab. Here you will notice 2 boxes. The values required for each of these boxes can be found on the Halo Integrator module configuration page in your Halo Web Application, as shown earlier. Copy the secret value across and input your Web App URL, and then press the test configuration button. This will send a simple request to the Halo API, confirming that you have provided the correct configuration options.
If the test is successful, make sure you save your configuration so that the details are saved for future use.
Each of the integration tabs outline a set list of pre-requisites to run the integration import via the Halo Integrator. To check whether you have an integration enabled, and to ensure that your configuration will allow a successful import, press the Check Configuration button. Each pre-requisite will then have a tick or cross appear, depending on whether it was successful.
If any of the pre-requisites should return a negative result, the details of this negative result will be logged on the Processes tab.
The Processes tab is where all integration imports can be started. When the Start Processing button is pressed, any integration that is enabled will be processed. All details from the Sync will be logged into the text box provided. It is recommended that before setting up a recurring import, that the process is started manually at least once to confirm that there are no configuration issues.
To run an import sync via the Halo Integrator on a recurring schedule, you should create a scheduled task that points to the Halo Integrator application. You should include the parameter “AUTO”, as shown in the image above and in the Integrator. This AUTO parameter will begin the import process without user interaction, and will also close the integrator at the end of processing.
When the task is setup the "Start in" parameter should be set to the folder from which the integrator will run. This will ensure that the logs are saved in the correct folder.
It is recommended that the integrator is setup to run out of hours or during the quietest periods of the day where possible.