StableN/ASyncedN/A

Iru Integration (Kandji)

Updated Jun 30, 202615 viewsView on usehalo.com

In this guide we will cover:

  • What is the Iru Integration?
  • Enabling the Iru Module
  • Connecting to Iru
  • Sites
  • Assets
  • Halo Integrator

What is the Iru Integration?

The Iru integration can be used to import assets against Halo sites, and sync them on a recurring basis.

Enabling the Iru Module

In Configuration > Integrations > Asset Management and Alerting, find the "IRU" module. Hover over it and click the "+" icon to enable the module.

Fig 1. Enabling the module

Connecting to Iru

Clicking into the module will show a list of any existing connections. Click the "New" button.

Fig 2. Iru connections

This will show the "Details" tab to create a new Iru connection. Give the connection a name, and enter your Iru URL (both regular and API) and API Token.

The API Token can be obtained from Iru. To generate the token, open your account menu in the bottom left of the Iru dashboard, then choose "Access". Select the API tokens tab. The API URL can be found here, and will likely be one of the below formats.

  • US: https://{SubDomain}.api.kandji.io
  • EU: https://{SubDomain}.api.eu.kandji.io

Choose "Add Token" and give it a name, then "Copy Token". Save the token and choose "Continue" to manage the API permissions.

On the API token page, choose "Edit" and grant read-only permissions (GET endpoints) for devices, then save.

Fig 3. Connecting to Iru

Upon saving, you can then click the "Test Configuration" button that will appear. A popup will then show to tell if the test was successful. If the credentials are invalid, an error message will show here to help troubleshoot.

Fig 4. Testing connection

Sites

Since Iru does not have a concept of sites or clients, "Site Rules" can be set. These add criteria for which asset falls into a certain site.

A default site should be set for assets that do not match one of these rules.

Fig 5. Site configuration

Clicking the "Add" button will show this popup to map a Halo Site based on criteria. You can choose a field, and whether data that includes or omits certain information falls into that criteria. In this example, any asset's name that begins with "HAL" will be imported under the "Halo" client's "Default" site.

Note: Criteria is based on Halo fields, so any fields set here will need to be mapped in the following "Assets" tab.

Fig 6. Adding site rule criteria

Assets

Once sites have been matched, you can then import the assets.

The first field is the "Asset Matching Field", which will determine how assets are matched to existing records when updated. This should be an field that is unique per asset.

You can then set Field Mappings in the table below this. This determines which Halo fields information from Iru is pulled into.

Ensure every field that is used as site rule criteria is correctly mapped here to match that. For example, the site rules for "Halo/Default" were set to any asset where the "Name" field starts with "HAL". In this asset field mappings table, we have then mapped the "asset_tag" field from Iru to that "Name" field in Halo, so any devices where the asset tag starts with "HAL" in Iru will be assigned to that "Halo/Default" site.

Fig 7. Asset configuration

Clicking the "Add" button will bring up the below pop to map an Iru field to a Halo field. This can be with both system asset fields or custom fields.

Fig 8. Mapping asset fields

After completing the Field mappings, you can then set the the Asset Type configuration.

  • Default Group for new Asset Types: Sets the asset group newly created asset types will be assigned to.
  • Determining an Asset's type: Sets how the asset type is determined.
    • Use the same type for all Assets: Assigns all assets to a set asset type.
    • Use a field to determine each Asset's type: A set field will be used for determining an asset's type. If an asset cannot match via this field, it will be assigned to a set default asset type.
    • Determine Asset Type using rules: Criteria can be mapped to asset types based on values in Halo fields. If an asset cannot match via this field, it will be assigned to a set default asset type.

Fig 9. Asset group and type configuration

Finally, set the miscellaneous Asset configuration.

  • Deactivate Assets in Halo when they are deleted from IRU (Halo Integrator only): If assets are deleted in Iru, they will be made inactive in Halo (via the "Active" checkbox) when syncing via the Halo Integrator.
  • Don't create new Assets: If enabled, assets will not be created, only updated.
  • Don't update the Asset type for existing or matched Assets: If enabled, pre-existing assets will not have their asset type updated (if different in Iru).
  • Don't update the asset site for existing or matched assets: If enabled, pre-existing assets will not have their site updated (if different based on the site rules).

Fig 10. Miscellaneous configuration

Save, and the assets can now be imported. Click the "Import Assets" button at the bottom of the tab.

Fig 11. Import Assets button

A button will show on assets imported, with a link to the device in Iru.

Fig 12. External link to Iru device

Halo Integrator

Once sites and assets are configured, you can enable the Halo Integrator to automatically sync assets.

Note: It is recommended to ensure you are happy with the configuration by manually importing before enabling automatic syncs via the Integrator.

Check "Enable the Halo Integrator for the IRU integration".

Fig 13. Enabling the Halo Integrator