Browse Guides

Xensam 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 Xensam Integration?</strong></p><p><strong>- Enabling the Xensam Module</strong></p><p><strong>- Connecting to Xensam</strong></p><p><strong>- Clients</strong></p><p><strong>- Assets and Data Centres</strong></p><p><strong>- Software Licences</strong></p><p><strong>- Halo Integrator</strong></p><p><strong>- Miscellaneous</strong></p><p><br></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 14pt;">What is the Xensam Integration?</span></strong></p><p>The Xensam integration can import clients, their assets and data centres, and the associated software and licences. These can then be imported on a recurring schedule via the Halo Integrator.</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the Xensam Module</span></strong></p><p>In Configuration &gt; Integrations, navigate to the Xensam module in the &quot;Asset Management and Alerting&quot; section. Hover over the module, and click the plus &quot;+&quot; icon to enable it.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImEwOTU4NmEwLTBhMGQtNDFkNy1hMDFhLWE5ZjUwYzhhNzJhNCJ9.BsD8TDq-i-afTAq3MiIwVCw82XQAWC4hD1MbSl3MLdQ" class="fr-fic fr-fil fr-dib" width="361" height="157"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the Xensam integration</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Xensam</span></strong></p><p>Clicking into the module, the connection details for Xensam can be entered at the top.</p><p><br></p><p>Credentials can be obtained from Xensam, and their documentation on this can be found <a href="https://wiki.xensam.com/s/73d58956-264b-4c44-94a0-297035386672/doc/xupervisor-api-guide-iQ3DkT5dlF" target="_blank" rel="noopener noreferrer"><strong>here</strong></a>.</p><p><br></p><ul><li>If hosted by us, IPs for whitelisting can be found <a href="https://usehalo.com/haloitsm/guides/1446" target="_blank" rel="noopener noreferrer"><strong>here</strong></a>.</li><li>A list of endpoints used by this integration are also listed so this can be provided to Xensam support.</li></ul><p><br></p><p>After entering the credentials received, click the &quot;Test Configuration&quot; button to confirm. If there are any issues, an error message will show to help troubleshoot this.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ODgzNjI0LTFjZTAtNDQ1OC04ZWE1LTc1YWJjODViZjk5YiJ9.CCMsdegrdlOjVxKGI4oh3kodcRvEowsPFEaXrzhX4kw" class="fr-fic fr-fil fr-dib" width="1413" height="549"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 2. Entering Xensam credentials</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Clients</span></strong></p><p>Once connected, Xensam Organisations can be imported as clients in Halo. This needs to be done first to ensure the assets created after match to the correct client record.</p><p><br></p><p>Click the &quot;Add&quot; button.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjI4NGZmM2YzLTNiZjQtNDcyYi1hOTAxLWZiM2JjYWQyYmFjYSJ9.n2wyBTaWSQhd9ATFKiktV-2G5AZ-D5EEa4U3TaUsRJs" class="fr-fic fr-fil fr-dib" width="1677" style="width: 1679px; height: 292.034px;" height="292"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 3. Customer configuration</span></strong></p><p><br></p><p>A popup will show to map the client records.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFmZDg5ODkwLWExOWYtNDFlNy1hYTNmLTY3ZWNiMTQzNmViZCJ9.maJHUWXt5flq4oINIrM99yjwaYia6YwQSLWgajIHs-g" class="fr-fic fr-fil fr-dib" width="720" height="335"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 4. Mapping customer records</span></strong></p><p><br></p><p>Once each client is mapped, click the &quot;Import Clients&quot; button under the table.</p><p><br></p><p><strong><span style="font-size: 14pt;">Assets and Data Centres</span></strong></p><p>Both assets and data centres in Xensam will be imported as Halo assets. The behaviour of how these are imported is configured in the &quot;Asset Import Settings&quot; section.</p><p><br></p><ul><li data-pasted="true"><strong>Default Site:&nbsp;</strong>Assets will be assigned to this Site if they are not linked to a User during the import.</li><li><strong>Default Group for new Asset Types:&nbsp;</strong>Sets the asset group newly created asset types will be assigned to. Xensam Asset Types are matched to existing Halo Asset Types via their name.</li><li data-pasted="true"><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:&nbsp;</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. New types will be created automatically if no type exists with a description matching the fields value. If the asset type creation fails, 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><li><strong>Default Asset Type:&nbsp;</strong>Sets the asset type that will be used as the default, either if using the same type for all assets or as a catch all if attempting to match.</li><li><strong>Asset Matching Field:&nbsp;</strong>This field is used to match Assets to existing records. If matched, the record will be updated.</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNhODQzNzAzLTM0MzYtNGQ0MC1hNjA0LTk1NmJlNzZiYjZmOCJ9.GW0igXc_VZSib66akQm4MPL8kfLYPwCKuS5099lNsjM" class="fr-fic fr-fil fr-dib" width="837" height="834"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 5. Asset configuration</span></strong></p><p><br></p><p>Following setting those defaults, field mappings can be added for both assets and data centres separately.</p><p><br></p><p>The asset field mappings can be set first. Click the &quot;Add&quot; button.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc2ODNmNTcyLTE4ODYtNDMwMS1hY2QyLWE1MjgyYWE3MzVhNSJ9.FQpcFbqqKYfmSH_x1V5xvBoL-d5nqrtqGRqNuO0UtUw" class="fr-fic fr-fil fr-dib" width="1695" style="width: 1697px; height: 236.735px;" height="237"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 6. Asset field mappings&nbsp;</span></strong></p><p><br></p><p data-pasted="true">A popup will show to map the asset fields. Both asset fields and custom fields of entity &quot;Asset&quot; can be mapped here.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI1YTc4NTYyLTg1NjYtNDFmZS1hOTFmLWE1NjAyZjAwMGRmNyJ9.en2yN9I7ZrGj2FuuLHns_nYZH6I7XfqmVJYOpyuTSYo" class="fr-fic fr-fil fr-dib" width="718" height="493"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 7. Mapping asset fields</span></strong></p><p><br></p><p data-pasted="true">Once each asset is mapped, click the &quot;Import Assets&quot; button under the field mappings table.</p><p><br></p><p>The same process can then be repeated with Data Centres. Click the &quot;Add&quot; button.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjMjJkMGZjLTVhYzEtNGMwYS1hYmJiLTYzZmE3MjBmOTgyNCJ9.mCPVXW0vkh357oEXlyUzJ3NvfRmXFj4PRwJtJFM_uV4" class="fr-fic fr-fil fr-dib" width="1690" style="width: 1692px; height: 226.714px;" height="227"></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 8. Data Centre field mappings</span></strong></p><p><br></p><p data-pasted="true">A popup will show to map the asset fields for data centres. Both asset fields and custom fields of entity &quot;Asset&quot; can be mapped here.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY5MGJkNTExLWZjYWUtNDcyNy1hMGFiLTRlZjY0ZTVjZmJiOSJ9.d3alTB3YI6T6FZDgvG6sD9Xc26pg1xB8BCrl13FrO8g" class="fr-fic fr-fil fr-dib" width="715" height="493"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 9. Mapping asset fields for data centres</span></strong></p><p><br></p><p data-pasted="true">Once each data centre is mapped, click the &quot;Import Data Centre&quot; button under the table.</p><p><br></p><p><strong><span style="font-size: 14pt;">Software Licences</span></strong></p><p>Software licences can be imported. These will be assigned to the client record, and will not be associated to individual asset records.</p><p><br></p><p data-pasted="true">Click the &quot;Import Software Licences&quot; button under the table. Ensure clients have been mapped and imported previous to this.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhiODVjZGRhLTU1OTItNDIyNy04ZDdjLTRmOTU3MDY5ZTIzNyJ9.Eq-PGAKN46nsy4X4E_mhP74W0-pKOpKCFRLZbldnNdQ" class="fr-fic fr-fil fr-dib" width="609" height="160"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 10. Importing software licences</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Halo Integrator</span></strong></p><p>To import each of these on a recurring basis, enable the Halo Integrator and choose which entities to sync.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmZjEyYTg0LTY4NDgtNGQzNy05ZGMyLTRkNTg3OGMwNjUwMSJ9.mfBBGfAcDH5L_X4-O9xYZNkldczDt8o1RUQ_UPXFTYk" class="fr-fic fr-fil fr-dib" width="1109" height="299"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 11. Enabling the Halo Integrator</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Miscellaneous</span></strong></p><p>Following enabling the integrator, some miscellaneous settings that also be enabled to change the behaviour of how assets are updated.</p><p><br></p><ul><li data-pasted="true"><strong>Deactivate Assets in Halo when they are deleted from Xensam (Halo Integrator only):</strong> If assets are deleted in Xensam, they will be made inactive in Halo (via the &quot;Active&quot; checkbox) when syncing via the Halo Integrator.</li><li data-pasted="true"><strong>Do not update an Asset&#39;s type if the Asset already exists:</strong> If enabled, pre-existing assets will not have their asset type updated (if different in Xensam).</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg3MTY2Mzc4LTQzODUtNDFkOC05NGE2LWE2OWIzNDcwMmRiOCJ9.2ok1_kKlY1BR6XmAwjtHEm0tCMTXkjmle_SWs1uPexc" class="fr-fic fr-fil fr-dib" width="579" height="149"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 12. Miscellaneous configuration</span></strong></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.