HaloPSA

HaloPSA Guides

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

Guides > Lansweeper Integration

Lansweeper Integration

Pre-Requisites


Your Lansweeper database must be in SQL Server Standard format to use this integration. If your Lansweeper database is a SQL Server Compact database, you will need to convert this into a Standard SQL database before continuing. 


General Configuration


To enable the Lansweeper integration in Halo, go to Configuration > Integrations, and enable the module. Once the module has been enabled, click the menu icon for the module to begin configuring it.


As the Lansweeper integration is effectively an import from one SQL database to another, access to the Lansweeper database is required. This means there is no import facility within the web application itself, and instead, a separate tool called the Halo Integrator must be downloaded. More details will be given regarding the Halo Integrator later in this guide.


SQL Details


Both Lansweeper and Halo have a SQL database. This integration is an import from one SQL database into another, and the Halo Integrator will need details of how to connect to your Lansweeper database. Under the SQL Connection header in the Lansweeper module, there are five options that allow you to specify connection details for your SQL Server where the Lansweeper database is held, and also the query that should be run against the Lansweeper database for the import.



The Halo Integrator will attempt to import any record that is returned via the SQL query. Later in the integration setup, you have the option to match fields from the Lansweeper database to Asset fields in Halo. You should ensure that any information you would like importing into Halo is selected in this SQL query.


By default, a SQL query has already been provided for you, and the majority of other configuration options have been already completed to work with this default query. This query can be adjusted if you have additional information that you would like to retrieve from Lansweeper, however, the default query will likely retrieve all of the information that you need.


Key Fields


Next you are given the option to choose some key fields for the import. These key fields have already been setup to work with the default query provided to you, and will not need adjusting unless you make changes to the query.


The first option available for you to specify is the name of the Unique Asset Identifier field from your query. This field will be used to match existing records to records that are being imported, so that you do not get duplicated Assets when the importer is run for a second time.



It is important that this field holds a unique value that does not change, otherwise duplicate Assets will be created during subsequent syncs, or the incorrect Asset may be updated.


The next key field is the name of the Asset Type field. The field you choose here should contain the name of the Asset Type of the Asset in Lansweeper. The value that is returned from the query for this field must match the name of an Asset Type in Halo. If a value is returned that does not equal the name of an Asset Type, then the Asset will fail to import.


Tip: If you do not wish to select an actual Asset Type field in your Lansweeper query, or you wish to import all Assets into the same Asset Type, you can hardcode a value in your query. For example, SELECT 'Lansweeper Assets' as [AssetTypename] FROM Table. In this example, AssetTypename would be your Asset Type key field. This would set the Asset Type of all Assets you import to Lansweeper Assets (if it exists).


The next key fields help identify the Site that the Asset belongs to, and the User of the Asset. In the same way that you have chosen an identifying field for Assets and Asset Types, you should now choose a field name from your Lansweeper query which will be used to identify the Halo Site by its name. There is also an additional option for you to choose a default Site, so if the fields value does not match to any Site names, then the Asset will be assigned to the default Site.



Tip: To import all Assets into the same Site, add a hardcoded field to your SQL query. For example, SELECT 'Lansweeper Site' as [SiteName] FROM Table. In this example, SiteName will be your key field, and all Assets would be assigned to the Site 'Lansweeper Site' if it exists.


Similarly, choose a field name from your Lansweeper query that will return the details of the User that is associated with the Asset. This field should contain either the Username, Email Address, or Network Login of the User. You should then set the User Matching Field to one of these three values, depending on the data you expect to be returned. For example, if your User field returns the Username of an Asset's User, you should choose Username in the matching field. This is so that the User can be correctly identified in Halo and then assigned to the Asset. In the default query, the users Network Login is returned, and the default key field options reflect this.


Field Mappings


It is possible to map fields that are returned in your SQL query to Halo Asset fields. You must ensure that any field you wish to map is returned in your query. To add a new mapping, press the plus icon in the top right corner of the table.



First specify the name of the field in your Lansweeper query. Then you must choose which field you would like to map the Lansweeper field to in Halo. There are some system fields available, along with the option of *Asset Field*. If this option is chosen, when importing, a field will be created with a name equal to the Lansweeper query field name. If a field already exists with that field name, or after it has been created, the data from the Lansweeper field will be mapped into the Halo field.


Tip: You can also create mappings for the fields used in Key Fields if you wish. For example, you will be able to see the value of the Asset's unique ID field unless you also map it to another Halo field.


Advanced Configuration


There are two advanced options available for this integration. 




Firstly, you can assign an Asset to a User's Site if a User is matched during the import process using the key fields. This works as an override, so the User's Site will take precedence over all other Site matching.


Secondly, if you would like the import to only update pre-existing Assets, and not create any new records, then the second option should be enabled.


Halo Integrator


As previously mentioned in this guide, you need to download and configure the Halo Integrator to import data from Lansweeper. Although the comprehensive setup of the Halo Integrator is not detailed in this guide, there are crucial steps you should take into account.

First and foremost, ensure that the integration feature is activated in the Halo Integrator. Once enabled, two additional fields will appear, indicating the last successful run time and any potential errors encountered during the process. This setup is especially useful when running imports on a recurring schedule, as it promptly alerts you to any issues that might arise during the import process.



The Halo Integrator must be run in a location that is able to connect and access your SQL Server using the connection details you have configured in the integration setup. In circumstances where the SQL query fails to execute, details about the failure will be displayed on the Processes tab.

Popular Guides