HaloCRM

HaloCRM Guides

Guides > Kaseya VSA Integration

Kaseya VSA Integration

In this guide we will cover:

- What is the Kaseya VSA Integration?

- Obtaining Kaseya Credentials

- Authenticating the Integration

- Importing Clients

- Importing Assets 

- Import Assets and Clients Automatically

- Alerting



Related Guides:



What is the Kaseya VSA Integration?

The Kaseya VSA integration allows assets and clients to be imported into Halo from Kaseya VSA. Alerts can also be configured to automatically create tickets in Halo each time an alert is triggered in Kaseya. Alerts, asset and clients are imported on a schedule using the Halo integrator. 


Note: If using VSA X, you will need to connect via the Kaseya VSA X integration, available as of v2.214.1+. The guide is linked above.


Obtaining Kaseya Credentials

Obtain OAuth 2.0 credentials from the VSA Server Visit the VSA server to obtain OAuth 2.0 credentials such as a client ID and client secret that are known to both the VSA and your application. This can be done from System > Server Management > OAuth Clients. Once the client is registered, a client_id and client_secret are generated by the system. The client_id is shown on the UI post registration, and both the client_id and client_secret are sent to the email address provided at the time. The client_secret is confidential and must be stored securely by the application. 


Figure 1 shows an example of where this is setup in Kaseya VSA.


Fig 1. OAuth in Kaseya


When setting this up you will need to enter a redirect URL into Kaseya VSA. 

Fig 2. Entering a redirect URL


The redirect URL used will differ depending on the version of Halo you are using.


On versions prior to v2.200 the following redirect URI will need to be used:

On versions v2.200+ you the following redirect URI will need to be used:

Note: If you have disconnected to the integration and are reconnecting, if your Halo instance is on v2.200+ you will need to use the new redirect URI (https://YOURHALODOMAIN/authcallback).


Authenticating the Integration

Once this is complete and you have your Client ID and Client Secret from Kaseya VSA you will need to enter these into Halo on the integration page and click Authorize to connect the application.


Go to Configuration > Integrations and then enable the integration for Kaseya.

Fig 3. Enabling the module


Then click into the module to begin configuration. Here you can add in the credentials.


Fig 4. Setup


Kaseya URL – This is the URL of your Kaseya site. This needs to be the root of the site.


Once you have added credentials and authorised your connection, further configuration options will be available. 


Importing Clients

Kaseya VSA organisations can be imported into Halo to create clients (and sites) in your Halo instance. 


If you do not yet have any clients in your Halo instance you can hit "Import Clients" to import all your organisations in Kaseya VSA. 


If you already have clients in your Halo instance, you will need to map each Kaseya Organisation to the correct Halo client and site before importing. This will determine which Halo site each asset in Kaseya will be created under. 

Fig 5. Client mappings


To create a mapping simply add to the mappings table and choose the Halo site and Kaseya Organisation you would like to map together.  


Any unmapped Kaseya Organisations will attempt to match to Halo clients and sites based on their name. If a match cannot be found based on name, a new client will be created. 


To manually import Clients/Organisations, hit "Import Clients" once mappings are complete. 


Importing Assets 

Next you will need to configure how assets are imported into Halo. Settings for this are found under the "Asset Imports" section. 

Fig 6. Asset Import options


Only import Computer Agent Assets (otherwise import all discovered assets) - When enabled, only Computer Agent Assets will be imported from Kaseya, no other assets will be imported. When disabled, all assets found in Kaseya will be imported. 


Default Site - Here choose the site assets should be created under if they cannot be matched to a site in Halo. Assets are matched to sites based on the Halo site that is mapped to the Kaseya Organisation they are under. If an asset's Kaseya Organisation is not mapped to a Halo site, the site chosen here will be the site they are created under. 


Asset Matching Field - Here choose the asset field in Halo that will be matched on during the import. If the field value in Halo matches the value of the mapped Kaseya field, an existing asset will be updated, if no match can be made a new asset will be created. The unique identifier of the asset should be chosen here. 


Asset Matching Value Exclusions - 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 'None' they would match even though they are separate assets. By adding the value 'none' to the matching value exclusions list you can ensure the assets are matched using their Kaseya VSA instead. 


Determine Asset Types

All assets in Halo will need to have an asset type therefore you will need to map Kaseya Asset types to Halo asset types. This is done using the Asset Type Mappings table. 

Fig 7. Asset Type Mappings


Mapping Workstation Operating System" and Server Operating System

The asset types "Workstation Operating System" and "Server Operating System" cannot be mapped to Halo asset types using this table. Instead, use the fields "Asset Type Override for Workstation Operating System" and "Asset Type Override for Server Operating System" (respectively) to determine which Halo asset types are mapped to these asset types. 


To map the fields for these asset types you will then need to map the chosen Halo asset type to any Kaseya asset type (in the mappings table) and add field mappings for the asset types here.


Field Mappings

When mapping asset types you will also need to complete field mappings. Field mappings will control which fields in Halo data from Kaseya will be imported into for this asset type. 


When adding a new field mapping, you will be presented with the screen shown in figure x. 

Fig 8. New Asset Field Mappings


Field Type - This will be the type of Halo field the data will be imported into. See our guide on Asset Fields if you are unsure on the difference between asset fields and custom fields in Halo. 


Only apply this mapping to new Assets and Assets where the Asset field does not currently have a value - When this is enabled if the Halo field already has data within it, different to the data in the mapped Kaseya field, the field data will not change. Fields will only be populated when they contain no data or when new assets are being created. 


If you would like the data in the Kaseya field to be added to a new asset field in Halo, select *Create a new Field during the next import* as the "HaloPSA Field".


Ensure you map all the relevant fields for each asset type. 

Fig 9. Asset Type field Mappings


Default Asset Type - Ensure you set this along with completing asset type mappings. This will determine they asset type new assets are created as if they cannot be matched to an asset type in Halo. 

 

Once you have configured how assets will be imported, hit "Import Assets" to begin a manual import. 


Import Assets and Clients Automatically

The Halo integrator can be enabled for this integration to have assets and clients imported automatically on a scheduled basis. This ensures asset data in Halo is always up to date with changes made in Kaseya. 


To do this, check "Enable the Halo Integrator for the Kaseya VSA integration" under the "Halo Integrator" section. 

Fig 10. Enable the Halo integrator for Kaseya VSA


Note: Host customers will have the Halo integrator hosted for them and will not need to download the Halo Integrator application. 


Once enabled, choose which entity data you would like to sync, Clients, Assets, Alerts or all data. Information on syncing alerts in Kaseya is covered in the next section. 


Alerting

Alert processing can be enabled for Kaseya to have alerts from Kaseya automatically create tickets in Halo. Allowing you to manage alerts from Halo. 


Enable alert processing using "Enable alert processing" under the "Alerting" section. 

Fig 11. Enable Alert Processing


Once enabled, you will need to use the settings below to control how alerts log tickets in Halo. 


New Alert Ticket Type - Here, choose the ticket type you would like alerts from Kaseya to log. You may wish to create a new ticket type for this or use the "Alert" ticket type we have available out of the box. 

New Alert User - Here, choose the user you would like alert tickets in Halo to be assigned to if the asset or client associated with the alert cannot be matched to a user in Halo. This will act as a fallback. 


Use AssetName to match Assets to alerts - When enabled the AssetName of the asset in Kaseya will be used to match assets to alerts in Halo, allowing Halo assets to be linked to the alert ticket automatically. We recommend enabling this. 


Once you have setup alerting configuration, ensure alerts are enabled for the Halo integrator for the integration. Entities to import will either need to be set to "Alerts" if you only want to bring in alert data, or "All" if you want to bring in alert and asset data. 

Fig 12. Enable the Halo integrator for alert processing


Now, any alerts triggered in your Kaseya instance will be imported into Halo, logging a ticket for the alert automatically. Alerts will be imported on a schedule. 

Popular Guides

Pin It on Pinterest