HaloPSA

HaloPSA Guides

Documentation to assist with the setup and configuration of the HaloPSA platform

Guides > Halo Asset Discovery (Lansweeper Cloud)

Halo Asset Discovery (Lansweeper Cloud)

In this guide we will cover:

- What is Halo Asset Discovery?

- Requirements of the Integration

- Connecting to Halo Asset Discovery

- Adding Mappings

- Optional Configuration

- Importing Assets

- Connecting to the Halo Integrator



What is Halo Asset Discovery?

Halo Asset Discovery is the hosted cloud version of Lansweeper, allowing import and management of assets.


Requirements of the Integration

This guide explains how to connect Lansweeper's Web Application with Halo's Asset Discovery integration. While demonstrated in trial instances, the setup for a connection between two production instances follows identical steps.


The following is required for setup of this integration:


  • Purchase of Halo Asset Discovery via an agreement between your organization and Halo Service Solutions or a previous purchase of Lansweeper. 
  • Lansweeper's Hosted Version known as "Lansweeper Sites".
    • If your Lansweeper instance is hosted in an On-Premise SQL database instead of Lansweeper's Web App, we suggest considering a discussion with your Lansweeper representative. Explore the feasibility of transitioning to Lansweeper's hosted version, their flagship product featuring all the latest and future developments, along with robust support services.
  • Lansweeper to be setup (Lansweeper support at support@lansweeper.com is more than well equipped to assist with this).

Fig 1. Lansweeper setup.


  1. Site prepared.
  2. Scanning device.
  3. Assets processed.


Connecting to Halo Asset Discovery

Navigate to your Halo Asset Discovery integration setup page. You can find this in Configuration > Integrations > Halo Asset Discovery or <Halo Agent Portal URL>/config/integrations/haloassetdiscovery.


Click "Authorize Application".

Fig 2. Authorize Application button.


This will redirect you to your hosted instance of Lansweeper. You will then be redirected back to Halo where you can start making specific configuration changes.


Fig 3. Connected Halo Asset Discovery instance with a connection type set.


Choose a connection type from the below.


  • REST API (Representational State Transfer API) - Recommended.
    • REST APIs are designed to provide a standardized way for clients to interact with a server or web service, enabling CRUD (Create, Read, Update, Delete) operations on resources through the use of HTTP methods and URLs.
  • Export API.
    • Export APIs are primarily focused on allowing users or external systems to extract data from a system or application in a structured format, such as CSV, Excel, or XML, often including features like pagination and filtering to facilitate data retrieval.


Adding Mappings

Click the "Add" button under the "Site Mappings" table to configure Halo to import assets from a specific site in Lansweeper to a specific site in Halo.


As of v2.180.1+, the "IP Address" criteria can be set within a range here.


Fig 4. Site Mappings table.


The following popup will then show to configure the mapping.


Fig 5. Adding site mappings.


There is also the ability to route to different sites based on site rules. To utilise these rules you will need to set up a mapping under Site Mappings using the value '*Determine site via rules*'


Fig 6. Determine Site via Rules


When this is set, you can create new site rules, via the site rules table, such as the criteria for a certain IP range.


Fig 7. Criteria for Site Rules


Now if the imported asset matches an IP address within this range, it will be routed to the Halo House site

Fig 8. IP Address Range Criteria for a Site Rule Mapping


When importing new assets, Halo will match entries onto the asset types that live in Halo at the time of the sync. If an asset type in Lansweeper does not exist in Halo, Halo will create a new asset type. You must configure which asset group that new asset type is generated under.


Fig 9. Setting a default group.


Field mappings are the rules which tell Halo what information to pull from Lansweeper and where to store the information once the asset is brought into Halo. Click "Add" on the "Field Mappings" table to start building our your field mappings.


Fig 10. Field Mappings table.


The popup to configure the mapping will then show like below. 


Fig 11. Adding field mappings.


You can select among various "Halo Asset Discovery Field Type" (Categorizations of fields from Lansweeper) and then select the field itself. Then you designate which Halo field this will come in as. 


Note: If mapping to "*Create a new Field during the next import*", it will to auto-match onto Halo fields with the same name as the Lansweeper field. If no field exists with the same name (name has to be exact match), the a new field will be auto-generated to store the information.


Set the asset matching field. This field tells Halo what value to watch out for in case the same exists in its database already. In that case, Halo would update an existing asset in your system rather than creating a new one (potentially duplicating assets).


Fig 12. Setting an asset matching field.


Setup the asset type matching logic. You can set one of three options.


Fig 13. Setting the method to determine asset type.


This is for the simple import where every asset from Lansweeper should be imported as a single asset type. Once selected, you will be prompted to select an asset type for assets to be imported into Halo as.


This allows you to differentiate the asset type of the asset based on a field against the asset type. At the moment, this option only allows you to select the "Type" field from Lansweeper. This field is intended to match well with the type field in Halo. This configuration is most commonly used.


This allows you to write additional logic to decide which assets come in as what asset types based on rule sets. When selected you are prompted with the below table. Click "Add" to create a new rule. 


Fig 14. Asset type configuration.


The popup will then show to configure the asset type mappings.


You select which asset type this rule matches to. Multiple conditions can be added in the criteria table.


Fig 15. Adding asset type mappings.


Also with this selection, you are able to tell Halo to not pull any assets that do not match a rule.


Fig 16. Setting to not import assets if they do not match rules set.


Optional Configuration User Matching

Assets imported from Halo asset discovery can be matched to the correct user in Halo on import, based on their user in Lansweeper. From v2.190+ you can toggle this functionality on and off using the setting 'Allow user matching'. On versions prior to this user matching will always be enabled. 


When user matching is enabled you can choose which field will be used to match users in the 'User Matching Field'. However, regardless of how this field is set user matching will always be attempted on the username, email, and network login fields. 


Under the user matching field you will see additional settings that control how user matching functions, shown in figure 17. 


Fig 17. User matching and optional configuration.


As of v2.180.1+, partial user matching is available with the checkbox 'Allow partial matching on the email address, network login and User matching fields'. When enabled, partial matches are made if an exact match cannot be found: first based on the network login, followed by the email address, and then matching field (provided one is set in the "User Matching Field" dropdown).


Enable user matching for certain asset types only (v2.190+)

From v2.190+ you can restrict asset user matching to selected asset types in Halo. This allows you to have certain asset types match to their corresponding user, but have others not matched, therefore not assigned to a user. 


To do this you will need to disable user matching for halo asset discovery globally. This is done using the setting 'Allow User matching' (as seen in figure 17), disable this. 


When disabled now head to the asset type in Halo you would like user matching to be enabled for, configuration > asset management > asset types > select an asset type > details tab > enable 'Allow User matching for this Asset Type for the Halo Asset Discovery integration'. 

Fig 18. Allow User matching for this Asset Type for the Halo Asset Discovery integration.


Note: This setting will only appear against asset types when user matching is disabled against the Halo asset discovery integration. 


When this option against the asset type is enabled, next time assets of this type are imported from Lansweeper/Halo asset discovery, a user will be attempted to be matched to the asset. 


Importing Assets

The method differs based on the API method being used.


Export API

Click the "Export Data" button to begin an export of site information from Lansweeper. This is a required step prior to importing asset entries.


Once exporting has begun, you can check the progress of your export in the table below it.


You can then use the "Import Assets" button to run a manual import (optional).


Fig 19. Asset Imports when set to Export method.


REST API

When set to the above, assets can be manually imported for mapped sites. Click "Import Assets" to bring up the import screen.


Fig 20. Asset Imports when set to REST method.


Connecting to the Halo Integrator

Check the below box to enable this integration for the Halo Integrator to run when its schedule permits.


It is worth noting, the Halo Integrator is generally a hosted application which Hosted customers of Halo Service Solutions will already have setup for them. If you have questions regarding the state of your Halo Integrator application, please reach out to your dedicated support team. You can find support information by going to the agent portal and hitting the '?' on the top right of your screen.


Fig 21. Enabling the Halo Integrator.

Popular Guides