Browse Guides

Device42 Integration
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 Device42 Integration?&nbsp;</strong></p><p><strong>- Enabling the Module&nbsp;</strong></p><p><strong>- Connecting to Device42</strong></p><p><strong>- Client Import</strong></p><p><strong>- Device Imports</strong></p><p><strong>- Webhooks</strong></p><p><br></p><p><br></p><p><strong><span style="font-size: 14pt;">What is the Device42 Integration?</span></strong></p><p data-pasted="true">Device42 can be integrated with Halo to import and manage Clients and Devices, and update these when they are created or updated in Device42. &nbsp; &nbsp;</p><p><br></p><p><span style="font-size: 14pt;"><strong>Enabling the Module</strong></span></p><p>In Configuration &gt; Integrations &gt; Asset Management and Alerting, hover over &quot;Device42&quot; and press the plus (+) icon to enable the Module.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQwNDUxMjk1LTEwZDktNDZkNi1iYzkxLWEyOWU1Y2RlYzQzOCJ9.CPSvd71yyozcC6Drb_ZGcAy42gako-CtVtdiXY10RfM" class="fr-fic fr-fil fr-dib" width="1099" style="width: 1101px; height: 500.693px;" height="501"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 1. Enabling the Module&nbsp;</strong></span></p><p><br></p><p data-pasted="true"><span style="font-size: 14pt;"><strong>Connecting to Device42</strong></span></p><p>Click into the Module to set up the connection between Halo and Device42. In the Setup section specify your Device42 URL, Username, and Password. Once set, click the &quot;Test Configuration&quot; to validate your credentials.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA5NDdmNzA1LWRjMTQtNDBjNy1hNTUzLWQzM2M5ZGFlZTlhNSJ9.tR3pupcIDUcTQtptYanUZX5aMoqSeLAPKo6yYAmfPC4" class="fr-fic fr-fil fr-dib" width="1099" style="width: 1101px; height: 267.029px;" height="267"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 2. Connecting to Device42</strong></span></p><p><br></p><p data-pasted="true"><span style="font-size: 14pt;"><strong>Client Import&nbsp;</strong></span></p><p>Once you have connected to Device42, you can configure your Client import. Under the Client Imports section add to the Customer Mappings table in order to map Device42 Customers to existing Sites in Halo. Any Customers not mapped here will match based on the Device42 ID, if no match can be found they will match on name.</p><p><br></p><p>Once you have set up your Customer Mappings, you can map Custom Fields by adding to the Custom Field Mappings table. Here you will be prompted to provide the Device42 Custom Field name and the Halo field to match to.</p><p><br></p><p><strong><em>Note: Custom Field mappings are case sensitive, so ensure the value is entered exactly as it is set in Device42. &nbsp;</em></strong></p><p><br></p><p>Next determine the Top Level for the imported Clients to be created under, and once you are happy with the configuration, click the &quot;Import Clients&quot; button.</p><p><br></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI1Y2VmZjBmLTg2YTgtNDEwMy1hNDBjLTA3NGZhOGM3MDY5YiJ9.1W7dDuuF85T5UauDknVOpVJPzKxhVlr0XMUfRcEmLdM" class="fr-fic fr-fil fr-dib" width="1116" style="width: 1118px; height: 445.366px;" height="445"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 3. Client Mappings &nbsp;</strong></span></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;"><br></p><p><span style="font-size: 14pt;"><strong>Device Imports</strong></span></p><p>Under the Device Imports section you can configure Device Type Mappings. Here you can determine what Asset Type the devices are created as in Halo. To do this, click &quot;Add&quot; on the Device Type Mappings table.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjgyZWFlYThmLTdhYTAtNDBiMy05OWIzLWEyNGFmZDRjYzRjYiJ9.79-pTULIuEA8s9z0VvDl6GaayXUuRYya3z1GhSf0Rco" class="fr-fic fr-fil fr-dib" width="1165" style="width: 1167px; height: 316.29px;" height="316"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 4. Device Type Mappings table</strong></span></p><p><br></p><p>Here you will need to specify the Halo Device Type (Asset Type) to create when the Device being imported matches the values specified in the: &quot;Device42 Type&quot;, &quot;Is a Blade Host&quot;, &quot;Tags&quot;, and &quot;Object Category&quot; fields. You can also decide whether to Include software for devices in this mapping. &nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMwNmQ5Mjg0LWExOGMtNGNjMy04ZGQ2LTNiODdjNTZlMzJiMiJ9.m7k4tvo00kkOtet-bWeQyOHQbu8KCR7nYmVxlDD0mAY" class="fr-fic fr-fil fr-dib" width="687" height="608"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 5. Device Type mappings&nbsp;</strong></span></p><p><br></p><p>Next you can map Device42 fields to fields in Halo. To do this, click &quot;Add&quot; on the Field Mappings table.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFjNTg1MDBkLTMxMzQtNGU4Ny04NWFjLWViOGI5Mzk1ZDkzOCJ9.bMIK2bGp-5XFFVwUAAZt3j-y5wUwww7VNhO8XOPQvuc" class="fr-fic fr-fil fr-dib" width="1222" style="width: 1224px; height: 334.413px;" height="334"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 6. Field Mappings Table&nbsp;</strong></span></p><p><br></p><p>When you add to the Field Mappings table you will be able to specify if the Device42 fields being mapped are Custom or System fields, and if these should be mapped to Asset or Custom Fields in Halo. Select the &quot;Only apply this mapping to new Assets and Assets where the Asset field does not currently have a value&quot; checkbox to prevent Device42 overwriting any values already set in the Halo fields.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQ1MjQ4YzE0LWU4OTgtNDZlMi1iYTlkLTNjNWEzZDgyMzkxMiJ9.FuFBQjirRTMwzSaJUO9F3VwRZBIYI2uXT5d2k95E9MQ" class="fr-fic fr-fil fr-dib" width="681" height="543"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 7. Device Field mappings &nbsp;</strong></span></p><p><br></p><p>Once all your field mappings are set you will need to set the Site for Assets to be assigned to if the imported device is has no associated Client, and the Asset Matching Field used to match Devices to existing records when the Device42 ID cannot be matched. To exclude certain values from being matched in the Asset Matching Field, click the &quot;Asset Matching Value Exclusions&quot; button. This will open the lookup codes section of configuration with the entity set to &quot;Device matching field ignore list&quot;. Adding new lookup codes against this entity will inform the system to ignore matching when the unique identifier has the value of the lookup. To prevent new Assets being created if the Unique Identifier has no value, select the &quot;Prevent import if the unique identifier is not provided&quot; checkbox.</p><p><br></p><p>Once you are happy with the configuration, click the &quot;Import Devices&quot; button.&nbsp;</p><p><br></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjI3YzhmNTU4LTJjYjAtNGQ1MC1iZmQxLTQ5YTUwYjBmN2EyNSJ9.q48T_R6B698TGY4hky8ACN2FbbmC8caVLlvie3MHrng" class="fr-fic fr-fil fr-dib" width="1170" style="width: 1172px; height: 331.547px;" height="332"></p><p data-pasted="true"><span style="font-size: 10pt;"><strong>Fig 8. Device import settings&nbsp;</strong></span></p><p><br></p><p><span style="font-size: 14pt;"><strong>Webhooks</strong></span></p><p>In order to receive updates from Device42, you will need to create a Webhook Endpoint in Device42. In Device42 head to Tools &gt; Webhooks &gt; Endpoints, and click &quot;Add Webhook Action&quot;. In Halo click into the &quot;Webhook Endpoint&quot; button, and copy the information across to the relevant fields in Device42. More information on creating Webhooks in Device42 can be found <a href="https://docs.device42.com/integration/external-integrations/external-logging-config/" target="_blank" rel="noopener noreferrer">here</a>.&nbsp;</p><p><br></p><p>Finally, set the &quot;Default Asset Type&quot; to be created when newly created Devices do not match a device type mapping configured previously.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc1MDkzZmZkLTU0NGMtNDY3Yy04MDMwLWIwMTJlZTE1OGQyZiJ9.JA6VHSz8Zq6KpzoRqmxN5IJhFgxT12Xrx-g8Mdqm1Sc" class="fr-fic fr-fil fr-dib" width="1122" style="width: 1124px; height: 276.047px;" height="276"><span style="box-sizing: inherit; font-size: 10pt;"><strong style="box-sizing: inherit; font-weight: 700;">Fig 9</strong></span><span style="box-sizing: inherit; font-size: 10pt;"><strong style="box-sizing: inherit; font-weight: 700;">. Creating a Webhook Endpoint &nbsp;</strong></span></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><br style="box-sizing: inherit; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;"></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.