Browse Guides

Snow 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 id="isPasted"><strong>In this guide we will cover:</strong></p><p><strong>- What is the Snow Integration?</strong></p><p><strong>- Connecting to Snow</strong></p><p><strong>- Customers</strong></p><p><strong>- Assets</strong></p><p><strong>- Software Licences</strong></p><p><strong>- Syncing</strong></p><p><br></p><p><br></p><p><span style="font-size: 14pt;"><strong>What is the Snow Integration?</strong></span></p><p>Instances of Snow can be integrated with Halo to import and manage assets. The integration will work for both internal and publicly accessible instances of Snow, however you will not be able to perform any imports through the web client to internally accessible Snow instances if your Halo could not access it.</p><p><br></p><p><strong><em>Note: Cloud hosted versions of Snow are now compatible with the integration. Functionality remains the same but credentials for connection will differ.&nbsp;</em></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Snow<br></span></strong></p><p>Multiple tenants of Snow can be connected to Halo.&nbsp;</p><p><br></p><p>After creating a new connection you will need to enter details required for connection.</p><p><br></p><p>You will be able to select the &quot;Instance Type&quot; to connect, dependent on if you are connecting a on-premise or cloud hosted instance.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjliYjA5NDQ5LWY5ZjEtNGY0Yi1hMmE4LWQxMzUyOThhZGM3MCJ9.8S1g_Qit5irIqgJt0S_DNUPAd0JW3b4t42nVoguaceY" class="fr-fic fr-fil fr-dib" width="1268" style="width: 1270px; height: 468.067px;" height="468"></p><p><strong><span style="font-size: 10pt;">Fig 1. Select Instance Type to connect</span></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Connecting an On-Premise Instance</span></strong></p><p>Enter your Snow URL along with a username and password of a user in your Snow instance. The user&#39;s details you use here must have the role &quot;API User&quot;.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjI4NDlhY2MzLWFhYmEtNGRjOC1hMWE3LTRiYTY0OTkxOWMwNyJ9.Fp0Q09N-4lyLNlCthmKnqCL8zBGZq1MRtvLP5WoHF2c" class="fr-fic fr-fil fr-dib" width="968" style="width: 970px; height: 512.317px;" height="512"></p><p><strong><span style="font-size: 10pt;">Fig 2. On-Premise Snow Connection</span></strong></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 12pt;">Connecting a Cloud Hosted Instance</span></strong></p><p>In order to connect Halo to your cloud hosted instance of Snow, you will need to create an application registration in Snow to obtain a client ID and secret for connection. For details on how to obtain these checkout Snow&#39;s documentation: <a target="_blank" rel="noopener noreferrer noopener noreferrer" data-fr-linked="true" href="https://docs-snow.flexera.com/snow-atlas/user-documentation/snow-atlas-settings/application-registrations/manage-application-registrations/">https://docs-snow.flexera.com/snow-atlas/user-documentation/snow-atlas-settings/application-registrations/manage-application-registrations/</a>.</p><p><br></p><p>You will also need to enter the region your instance is hosted in (this may be found in the URL of your Snow instance).</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY3YTcyNmJhLTIyZTktNGEwYy05Y2M2LWJkOGE2NmYwOTA3ZSJ9.zac9jIPRURw1QcarWVEmA-YTFTWwowTiuRuF-Q9Ul-0" class="fr-fic fr-fil fr-dib" width="1016" style="width: 1018px; height: 445.147px;" height="445"></p><p><strong><span style="font-size: 10pt;">Fig 3. Cloud Hosted Snow Connection</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Customers</span></strong></p><p>Once connected, Customers can be mapped and imported. Customers imported for the first time will update the existing record in Halo if the name in Snow is identical to the name in Halo. Once in the &quot;Edit&quot; view, click the &quot;Add&quot; button next to the table, and select each Halo customer to a Snow customer.</p><p><br></p><p>If top levels are enabled (Configuration &gt; Users &gt; General Settings &gt; &quot;Show an additional level (&quot;Top Level&quot;) for grouping Customers&quot;), a top level for each imported customer can be set here. You can also opt in/out of syncing addresses.</p><p><br></p><p>The customer import will also import licences but will only import licences for customers that have devices imported. Clients with no devices will not have licences imported. This means the first client import will also not import any licences so a client import, then a device import then another client import must be run to import licences. This is a limitation of the Snow API endpoints and the easiest way to access licences and link them without affecting device import speed.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjAwZjJkNDRiLWFmOTItNGZmYy04YjNkLTM2Y2JiNGQyZDgyYyJ9.ItLXMvCeE97DlIV_S4_ZiQmN8nQw5DNHwCmTgK7XVzo" class="fr-fic fr-fil fr-dib" width="1273" style="width: 1275px; height: 513.45px;" height="513"></p><p><strong><span style="font-size: 10pt;">Fig 4. Customer import</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Assets</span></strong></p><p>Once you&#39;ve imported your customers, you should then be able to import devices. No devices can be imported before customers are imported. Before importing devices, make sure to first set the default Site for assets to be imported into and the &quot;Asset-User matching type&quot;.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Determine Asset Sites and Users</span></strong></p><p><strong>Asset-User matching type -</strong> This determines how assets are matched and assigned to users in Halo.&nbsp;</p><p><strong>Don&#39;t update the asset site for existing or matched assets -</strong> When checked, existing assets will not have their site updated/changed. Assets will be assigned to a site upon initial import, but the site will not change on following syncs.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjkzMWUzZmFkLWYzOGYtNDI2MC1iNzhkLTUwOWNjZmZjYWNiMCJ9.u8HZ9ZBnZbYripsqZAK_2glDnexFskIu0x5GL19gFpo" class="fr-fic fr-fil fr-dib" width="1416" style="width: 1418px; height: 799.175px;" height="799"></p><p><strong><span style="font-size: 10pt;">Fig 5. Asset import configuration</span></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Determine Asset Types</span></strong></p><p>Then you will need to determine how imported assets are assigned an asset type. In Halo every asset must be assigned an asset type, however, as Snow does not have a concept of asset types you will need to configure how types are assigned.&nbsp;</p><p><br></p><p>Choose how imported assets&#39; types are determined, using the &#39;Determining an Asset&#39;s type&#39; field.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVjN2QyMDhiLWQ3NjQtNDFkNy04MDJkLWNmOWIzYjA4NzdkYiJ9.P0LqTjzrJ7o8AkG2c-z8i3lhvbgFijPyFVVm9cGR0bQ" class="fr-fic fr-fil fr-dib" width="1018" style="width: 1020px; height: 410.163px;" height="410"></p><p><strong><span style="font-size: 10pt;">Fig 6. &quot;Determining an Asset&#39;s type&quot; field</span></strong></p><p><br></p><p id="isPasted"><strong>Use the Same Type for all Assets</strong></p><p>If you would like all imported assets to have the same asset type when imported set the &#39;Determining an Asset&#39;s type&#39; field to be &#39;use the same type for all Assets&#39; then set the &#39;Default Asset Type&#39; field to be the asset type you would like assets from Snow to be.</p><p><br></p><p><strong>Use a Field to Determine each Asset&#39;s Type</strong></p><p>If you would like all imported assets&#39; types to be determined by a particular field, set the set the &#39;Determining an Asset&#39;s type&#39; field to be &#39;Use a field to determine each Asset&#39;s type&#39;. Then in &#39;Field for determining an Asset&#39;s type&#39; choose the field you would like the type to depend on. The field you choose must contain the name of the desired asset type, if this name can be matched to an existing asset type in Halo, it will be assigned this asset type. If the name is not the same as an asset type in Halo, a new asset type will be created. Note that the names must be identical in order to match. This setting is used if you have a field in Snow that already determines an asset&#39;s type, and you would like the types to be consistent between Halo and Snow.</p><p><br></p><p>When this option is selected, you will also need to set the &quot;Group for new Asset types&quot;. This will be the group any new asset types are created under.&nbsp;</p><p><br></p><p>In the figure 8 example new assets will be assigned to an asset type in Halo based on their &quot;Operating System&quot; field. If the data in the Operating System field matches the name of an asset type in Halo this asset will be created under the matched asset type. If a match cannot be made a new asset type will be created, under the asset group &quot;Computing&quot;.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQ2OWI0ZTI3LWRmY2EtNDk0MC04MmZlLThlZWViMjgxMWE2OCJ9.7zEzyUcHtjkZ0gz0JGZksQpgjehSq4o6AK80UkQKTeU" class="fr-fic fr-fil fr-dib" width="1445" style="width: 1447px; height: 246.775px;" height="247"></p><p><strong><span style="font-size: 10pt;">Fig 7. Using field to determine asset&#39;s type example&nbsp;</span></strong></p><p><br></p><p id="isPasted"><strong>Determine Asset Type using Rules</strong></p><p>If you would like asset types to be determined by asset rules set the set the &quot;Determining an Asset&#39;s type&quot; field to be &quot;Determine asset type using rules&quot;. Now you will be able to set asset&#39;s types based on rules. These rules are based on field values, and if matched will assign an asset to the chosen asset type. When creating a rule first add criteria for the rule, select the Halo field that you would like to base the criteria on, then set the rule type and the outcome needed in the field to match the rule. If an asset matches this rule, it will be imported as this asset type.</p><p><br></p><p data-pasted="true">The Rule Type &quot;Within Range (IP Addresses)&#39;&quot; can be set as criteria for IP address fields.</p><p><br></p><p>When using this method, you will need to complete the &quot;Default Asset Type&quot; field. If an asset is imported that does not match any of these rules, it will be created under the set default asset type.</p><p><br></p><p><strong>Don&#39;t update the Asset Type for Existing or Matched Assets -</strong> When checked, asset types will not be changed/updated after the initial import. Asset types will be set when assets are created, any following imports will update assets but will not update their asset type. Useful if you would like to be able to change the criteria for determining an asset&#39;s type without this impacting existing assets.&nbsp;</p><p><br></p><p><strong>Asset Matching Field</strong></p><p>Once you have configured how the asset types of imported assets are determined you will need to set the &quot;Asset Matching Field&quot;.&nbsp;</p><p><br></p><p id="isPasted"><strong>Asset Matching Field -</strong> Here choose the field is used to match Assets to existing records. This should be the unique identifier of the asset. If matched, the record will be updated. By default, the Snow ID will always be checked first. (assets will be assigned a Snow ID upon import).&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZmOGNjMTJlLTMxMzUtNGNlYi1iN2Y3LThkNTI3OTY0MDQxMSJ9.cki51AOcuB-wzJeSWIiUVb8fCWJLdzvZWZcKQrJ2uhc" class="fr-fic fr-fil fr-dib" width="1361" style="width: 1363px; height: 430.24px;" height="430"></p><p><strong><span style="font-size: 10pt;">Fig 8. Asset matching field</span></strong></p><p><strong><br></strong></p><p id="isPasted"><strong>Asset Matching Value Exclusions&nbsp;</strong>- Here you can set assets to not be matched using the matching field if the matching field contains a certain value. For example, if two assets have the matching field set to be &#39;None&#39; they would match even though they are separate assets. By adding the value &#39;none&#39; to the matching value exclusions list you can ensure the assets are matched using their Snow ID instead.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Field Mappings</span></strong></p><p>You can then set the &quot;Field Mappings&quot; for fields on your assets within the table below. This controls where data against assets is stored in Halo, that is, which fields data is imported into.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImE0NDhmYjgxLTJmYTctNGRiZi04ZTEwLTlmNTdlMDAzZWFkMiJ9.F1-Bm3GTmMKkJ5K-VJdSn1ZhFwswluoRlZjIYI0GChI" class="fr-fic fr-fil fr-dib" width="1371" style="width: 1373px; height: 388.699px;" height="389"></p><p><strong><span style="font-size: 10pt;">Fig 9. Field mappings</span></strong></p><p><br></p><p id="isPasted"><strong>Field Type -&nbsp;</strong>This will be the type of Halo field the data will be imported into. See our guide on <a data-fr-linked="true" href="https://usehalo.com/haloitsm/guides/1785/" id="isPasted" target="_blank" rel="noopener noreferrer">Asset Fields</a> if you are unsure on the difference between asset fields and custom fields in Halo.&nbsp;</p><p><br></p><p><strong>Only apply this mapping to new Assets and Assets where the Asset field does not currently have a value -</strong> When this is enabled if the Halo field already has data within it, different to the data in the mapped Snow field, the field data will not change. Fields will only be populated when they contain no data or when new assets are being created.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Additional Settings</span></strong></p><p>There also several miscellaneous options available for the device import shown in figure 8. These were added for those who&#39;d previously used the older Snow integration with the Windows Client to prevent the creation of new devices, changing of device types and changing of device locations due to the use of a new ID for the Snow Integration in the Web App.&nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA5MmRkZDQyLTE5ZTctNDAzNy1hZWE3LTY3NTNkNjQ1YzY4ZCJ9.c1zqmaAMfZ1es1fD0-rp7nbDeutt31qLLMXmGBxKJys" class="fr-fic fr-fil fr-dib" width="1323" style="width: 1325px; height: 486.06px;" height="486"></p><p><strong><span style="font-size: 10pt;">Fig 10. Additional settings</span></strong></p><p><br></p><p>Once you have completed your import configuration hit &quot;Import Assets&quot; to begin the import.&nbsp;</p><p><br></p><p><strong><em>Note: The Asset import imports both Computers and Mobile Devices as they are classified in Snow.&nbsp;</em></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Software Licences</span></strong></p><p>Once Customers and Assets are both mapped and imported, you can import software licences within the corresponding tab.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU1ZWZjYjQxLWE5ZTEtNGI1NS1iZDE2LTI0YzVlNTcxN2IzMiJ9.AckrJi_4WTNo2WBZH08hAGKVQZ3XXHBKSQH8kFEeXmI" class="fr-fic fr-fil fr-dib" width="758" height="318"></p><p><strong><span style="font-size: 10pt;">Fig 11. Software Licence import</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Syncing</span></strong></p><p>After importing all the above and ensuring the configuration is as you would expect it, you can enable the Halo Integrator to have Customers and/or Devices automatically update.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImE3ZmI3ZjVhLTdjNWItNDE4YS1iYzAzLWRlNWMxMmQxMzdjYiJ9.qe-s4yf7HCWaMI07g_k0AdrreYUoxDdEi5ZJG5g1e-0" class="fr-fic fr-fil fr-dib" width="1006" height="401"></p><p><strong><span style="font-size: 10pt;">Fig 12. Halo Integrator sync</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.