Browse Guides

Iru Integration (Kandji)
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Iru Integration?</strong></p><p><strong>- Enabling the Iru Module</strong></p><p><strong>- Connecting to Iru</strong></p><p><strong>- Sites</strong></p><p><strong>- Assets</strong></p><p><strong>- Halo Integrator</strong></p><p><br></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 14pt;">What is the Iru Integration?</span></strong></p><p>The Iru integration can be used to import assets against Halo sites, and sync them on a recurring basis.</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the Iru Module</span></strong></p><p data-pasted="true">In Configuration &gt; Integrations &gt; Asset Management and Alerting, find the &quot;IRU&quot; module. Hover over it and click the &quot;+&quot; icon to enable the module.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNhZTVhMTExLTlhNjEtNDQ2My1hMTBlLTRiZDBmYWU2Y2VlNCJ9.ajlE0PDR_ORbUxDuSfmj-SXJtjYR_AZj9nKib_eI1g0" class="fr-fic fr-fil fr-dib" width="357" height="144"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the module</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Iru</span></strong></p><p data-pasted="true">Clicking into the module will show a list of any existing connections. Click the &quot;New&quot; button.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2RmODhiLWI0NDUtNGZlMS1hNGY2LWQzZDI2YzdmN2Q3NyJ9.z17sbW_YRCEcDX7_Tv5LwBdWCrtSyNpu2WTQ1fis6kM" class="fr-fic fr-fil fr-dib" width="1690" style="width: 1692px; height: 111.569px;" height="112"></p><p><strong data-pasted="true"><span style="font-size: 10pt;">Fig 2. Iru connections</span></strong></p><p><br></p><p data-pasted="true">This will show the &quot;Details&quot; tab to create a new Iru connection. Give the connection a name, and enter your Iru URL (both regular and API) and API Token.</p><p><br></p><p>The API Token can be <a href="https://docs.iru.com/en/endpoint/api/iru-api-overview" target="_blank" rel="noopener noreferrer"><strong>obtained from Iru</strong></a>. To generate the token, open your account menu in the bottom left of the Iru dashboard, then choose &quot;Access&quot;. Select the API tokens tab. The API URL can be found here, and will likely be one of the below formats.</p><p><br></p><ul><li data-pasted="true"><strong>US:&nbsp;</strong>https://{SubDomain}.api.kandji.io</li><li><strong>EU:&nbsp;</strong>https://{SubDomain}.api.eu.kandji.io</li></ul><p>Choose &quot;Add Token&quot; and give it a name, then &quot;Copy Token&quot;. Save the token and choose &quot;Continue&quot; to manage the API permissions.</p><p><br></p><p>On the API token page, choose &quot;Edit&quot; and grant read-only permissions (GET endpoints) for devices, then save.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg1Zjc2NmNlLTlhOWYtNDk3Ni1hZDA1LTllOWNlNWJhOTZkYyJ9.SmLNr13PykKFB6JUd8HRZqcfTnNIECuk1tfYIu-eF2k" class="fr-fic fr-fil fr-dib" width="1695" style="width: 1697px; height: 391.853px;" height="392"></p><p><strong data-pasted="true"><span style="font-size: 10pt;">Fig 3. Connecting to Iru</span></strong></p><p><br></p><p data-pasted="true">Upon saving, you can then click the &quot;Test Configuration&quot; 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.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFiYzQ3OTRlLWVlYmEtNDZiNi1hZGYyLWIxNDZkMzBhMDZhOCJ9.r-0atd5zuGOzRh9445hXu1aN8X23hbNm9ror-am5bUY" class="fr-fic fr-fil fr-dib" width="1437" height="457"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 4. Testing connection</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Sites</span></strong></p><p data-pasted="true">Since Iru does not have a concept of sites or clients, &quot;Site Rules&quot; can be set. These add criteria for which asset falls into a certain site.</p><p><br></p><p>A default site should be set for assets that do not match one of these rules.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjgyZmVjODMxLTUyYTctNGM3Ni1hNjM2LWM4MTRkNzZlMTJiMCJ9.xaNyz5lXBNQu1MWaZbs2H2z7ccoILQ_dNM10RCRT9o0" class="fr-fic fr-fil fr-dib" width="1687" style="width: 1689px; height: 431.446px;" height="431"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 5. Site configuration</span></strong></p><p><br></p><p data-pasted="true">Clicking the &quot;Add&quot; 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&#39;s name that begins with &quot;HAL&quot; will be imported under the &quot;Halo&quot; client&#39;s &quot;Default&quot; site.</p><p><br></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;" data-pasted="true"><strong style="box-sizing: inherit; font-weight: bolder;"><em style="box-sizing: inherit;">Note: Criteria is based on Halo fields, so any fields set here will need to be mapped in the following &quot;Assets&quot; tab.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjBmYjk0ODdlLTlmZjMtNGE5Ni04ZjdlLTQ5Njg3ZWIxOTA0ZSJ9.or3VNQqxC-G2SqTM8L93qsskprm8paRSRhZamf5tRnU" class="fr-fic fr-fil fr-dib" width="712" height="538"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 6. Adding site rule criteria</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Assets</span></strong></p><p data-pasted="true">Once sites have been matched, you can then import the assets.</p><p><br></p><p data-pasted="true">The first field is the &quot;Asset Matching Field&quot;, which will determine how assets are matched to existing records when updated. This should be an field that is unique per asset.</p><p><br></p><p data-pasted="true">You can then set Field Mappings in the table below this. This determines which Halo fields information from Iru is pulled into.</p><p><br></p><p>Ensure every field that is used as site rule criteria is correctly mapped here to match that. For example, the site rules for &quot;Halo/Default&quot; were set to any asset where the &quot;Name&quot; field starts with &quot;HAL&quot;. In this asset field mappings table, we have then mapped the &quot;asset_tag&quot; field from Iru to that &quot;Name&quot; field in Halo, so any devices where the asset tag starts with &quot;HAL&quot; in Iru will be assigned to that &quot;Halo/Default&quot; site.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYxZWRiMjA0LWZmNGQtNGIxNC1iYWQwLWFhM2Q4OTM4YTI1OCJ9.DT0uZ6SLvfnbsSMWRHWUYu_7s7HAHYL7TaKDosl99do" class="fr-fic fr-fil fr-dib" width="1690" style="width: 1692px; height: 351.924px;" height="352"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 7. Asset configuration</span></strong></p><p><br></p><p data-pasted="true">Clicking the &quot;Add&quot; 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.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkMzY5ZWEyLWIxOTUtNDE2ZC1hN2ZkLTc1MGJlOWZjNzZkNSJ9.YzHmikKUqeeeogC5KzYE_SpqAGOSuKtbSidhH7a4sqY" class="fr-fic fr-fil fr-dib" width="715" height="414"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 8. Mapping asset fields</span></strong></p><p><br></p><p data-pasted="true">After completing the Field mappings, you can then set the the Asset Type configuration.</p><p><br></p><ul><li><strong>Default Group for new Asset Types:&nbsp;</strong>Sets the asset group newly created asset types will be assigned to.</li><li><strong>Determining an Asset&#39;s type:&nbsp;</strong>Sets how the asset type is determined.<ul style="list-style-type: disc;"><li><strong>Use the same type for all Assets:</strong> Assigns all assets to a set asset type.</li><li><strong>Use a field to determine each Asset&#39;s type:</strong> A set field will be used for determining an asset&#39;s type. If an asset cannot match via this field, it will be assigned to a set default asset type.</li><li><strong>Determine Asset Type using rules:&nbsp;</strong>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.</li></ul></li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM1ZGI1NTE1LTEzNDgtNDg4Ny05Njk0LTg0YmJkZDNhNTFkNiJ9.jh-hkRjmZVSl2z3l7jVndCPGsgvsSqU-iTbymbNSQ5o" class="fr-fic fr-fil fr-dib" width="1684" style="width: 1686px; height: 339.426px;" height="339"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 9. Asset group and type configuration</span></strong></p><p><br></p><p data-pasted="true">Finally, set the miscellaneous Asset configuration.</p><p><br></p><ul><li data-pasted="true"><strong>Deactivate Assets in Halo when they are deleted from IRU (Halo Integrator only):</strong> If assets are deleted in Iru, they will be made inactive in Halo (via the &quot;Active&quot; checkbox) when syncing via the Halo Integrator.</li><li><strong>Don&#39;t create new Assets:</strong> If enabled, assets will not be created, only updated.</li><li data-pasted="true"><strong>Don&#39;t update the Asset type for existing or matched Assets:</strong> If enabled, pre-existing assets will not have their asset type updated (if different in Iru).</li><li><strong>Don&#39;t update the asset site for existing or matched assets:&nbsp;</strong>If enabled, pre-existing assets will not have their site updated (if different based on the site rules).</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFiMDg2MGEzLThmNjMtNDRkNS1iMTM1LTE3YjIzM2NjYjNhYyJ9.k_DJoWtMnOk24izXNpXes_QvQMYBhCFO6XxXSVTjB74" class="fr-fic fr-fil fr-dib" width="531" height="266"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 10. Miscellaneous configuration</span></strong></p><p><br></p><p data-pasted="true">Save, and the assets can now be imported. Click the &quot;Import Assets&quot; button at the bottom of the tab.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlZWI3MTdkLTUxNTctNGRmYS1iMTJiLTY4N2VkMWQxMjg5MiJ9.YRlIUs0G8hDoHw0enIQ9PKOap2nHyBoRfqV7pciRocs" class="fr-fic fr-fil fr-dib" width="1690" style="width: 1692px; height: 926.204px;" height="926"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 11. Import Assets button</span></strong></p><p><br></p><p>A button will show on assets imported, with a link to the device in Iru.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM4MjVjZDcxLWRjODktNGU3NC1iZWRmLTE1NDVjODk1NGZjOCJ9.2hJECFYxII0w2SG1mWPzcvYb9R3wjMxqQk5NiUyvwXo" class="fr-fic fr-fil fr-dib" width="840" height="175"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 12. External link to Iru device</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Halo Integrator</span></strong></p><p data-pasted="true">Once sites and assets are configured, you can enable the Halo Integrator to automatically sync assets.</p><p><br></p><p><em><strong>Note: It is recommended to ensure you are happy with the configuration by manually importing before enabling automatic syncs via the Integrator.</strong></em></p><p><br></p><p>Check &quot;Enable the Halo Integrator for the IRU integration&quot;.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjBlNDhkNGZiLWQwMzgtNGI4Yi04MGZhLTRkMDI2NDBlMzlhMyJ9.MyXYZ0IHlxkI9wg2IehL6RjLXATG94OOclwIeEfTdsA" class="fr-fic fr-fil fr-dib" width="1214" height="416"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 13. Enabling the Halo Integrator</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.