HaloPSA

HaloPSA Guides

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

Guides > Atera RMM Integration

Atera RMM Integration

In this guide we will cover:

- What is the Atera RMM integration

- Connecting to Atera

- Importing Customers

- Import Assets

- Import Assets and Customer data automatically

- Alerting



What is the Atera RMM integration? 

This integration allows you to import customer and devices (assets) from Atera RMM into Halo, as well as have changes made to these entities in Atera sync to Halo automatically. Allowing you to manage your devices from your Halo instance. Atera alerts can also be integrated with Halo, allowing a ticket in Halo to be logged automatically when an alert is raised in Atera. Additionally, when the alert in Atera, or ticket in Halo is resolved/closed this will close/resolve the ticket/alert in the other application. This allows agents to manage and monitor alerts from your Halo instance. 


Connecting to Atera

First head to configuration > integrations and enable the Atera RMM integration module using the '+' icon. 

Fig 1. Enable integration module


Once enabled, click into the module to begin configuration. 

Fig 2. Atera RMM integration setup page


To connect to Halo to Atera you will need to enter your Atera application URL and an API key, the API Key must be generated in Atera RMM. To do this, open up Atera RMM > go to Admin > API. You can generate and copy your API Key from here.

Fig 3. API area in Atera RMM.


The Application URL is the URL that you go to when logging into Atera and is usually https://app.atera.com/.


Once you have entered these details in Halo you can use the 'Test Configuration' button to check you have connected successfully.  


Importing Customers

Customers can be imported from Atera into Halo, or if you already have your customers setup in Halo you can map your Halo sites to your Atera customers to link them. Mapping will ensure changes made to the customer in Atera will update the correct customer site in Halo. 

Fig 4. Customer import setup.


If you do not have any customers in your Halo instance yet and would like to use the integration to create these, use the 'Import Customers' button. When customers are imported a new customer with a site will be created in Halo. 


Top Level for Customers - Here, you can choose a top level, any customers created by the integration will be created under this top level. 


If your customers in Halo and Atera have the exact same name you will not need to configure mappings as these customers will match based on their name. If a Halo and Atera customer match based on name assets under this Atera customer will be imported to the main site of the matched Halo customer. However, for certainty we advise to complete mappings anyway. 


To map customers together use the 'Add' button against the mapping table. 


Once you have completed customer mappings use the 'Import Customers' button to begin the customer import. 


Import Assets

Devices from Atera RMM can be imported into Halo as assets.  

Fig 5. Importing assets setup.


Device Types to Import - Here, choose which device types from Atera that you would like to be imported into Halo. 

Default Site - Here choose a default site for assets to be imported to. This site will only be used if the customer the Atera device is against has not been mapped (or cannot be matched) to a customer/site in Halo. 


Atera RMM Asset Types are matched to existing Halo Asset Types via their name, this means if the Atera device has a device type that matches (has the same name as) an asset type in Halo, the device will be created as the matched asset type. If the device type does not match to a Halo asset type a new Halo asset type will be created for this device type. 


Note: The Atera device type will be determined by the ostype  field. 


Default Group for new Asset Types - Here, choose the asset group that new asset types will be created under. 


Asset Matching Field - Here choose which field to use when matching Halo assets to their corresponding device in Atera. If matched, the record will be updated. This field should contain the unique identifier of the asset. By default, the Atera RMM ID will always be checked first, any assets in Halo created by the integration will have an Atera RMM ID stored against them. Therefore, these assets will not reply on the matching field alone to match to the correct device in Atera. 


Field Mappings

Asset field mappings can be configured to ensure data from Atera is imported to the correct fields against the asset in Halo. To configure a field mapping add to the field mapping table in the integration setup page. 

Fig 6. New field mapping


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 Atera field, the field data will not change. Fields will only be populated when they contain no data or when new assets are being created. 


When you are happy with your asset import configuration use the 'Import Assets' button to bring up the import preview screen and start the import. 


Import Assets and Customer data automatically

To have asset and/or customer data sync from Atera to Halo automatically you will need to enable the Halo integrator for the integration. This is enabled using the 'Enable the Halo Integrator for the Atera RMM integration' setting on the integration setup page. 

Fig 7. Enable Halo integrator for integration.


Once enabled, choose the entities you would like to be synced, customers and/or assets. This will sync changes made to these entities in Atera RMM into Halo on a daily basis (24 hours). 


Deactivate Assets in Halo when they are deleted from Atera RMM (Halo Integrator only) - When enabled, assets in Halo will be deactivated when they are deleted from Atera RMM, only when assets are being synced using the Halo integrator. 


Alerting 

Altering can be configured to have alerts that are raised in Atera automatically create tickets in your Halo instance. Allowing agents to monitor and manage alerts from Halo. When the alert ticket is closed in Halo this will resolve the alert in Atera and vice versa. Alerts are processed using the Halo integrator which means they will be 


To enable alerting functionality enable the setting 'Enable alert processing' on the Atera RMM integration setup page. 

Fig 8. Enable alert processing for Atera RMM 


When enabled you will need to choose a method for processing alerts. The 'Halo Integrator' method should be chosen as the alternative method is depreciated. 


Note for on premise customers - Check if you are using NHServer to process backend services, if you are this will need to be on version 1325.01+ and you will need to select the NHServer method. However, NHServer is being depreciated therefore we recommend switching over to our incoming/outgoing services instead. An article on this can be found here. 


Now choose the ticket type that will be created when new alerts are detected and the user these alert tickets will be assigned to. The user chosen in the 'New Alert User' field will only be used if the asset the alert has been raised for does not have a user that can be matched to a user in Halo. 


Now, you will need to enable the Halo integrator for the integration so alerts can be imported automatically. Enable the setting 'Enable the Halo Integrator for the Atera RMM integration' then add 'Alerts' into the 'Entities to Sync' field. 

Fig 9. Enable alert syncing.


Now the Halo integrator is enabled for alerting this will run every 5 minutes, checking Atera for new alerts, if a new alert is found in Atera this will create a ticket in Halo. When the ticket is closed in Halo the alert will be resolved in Atera RMM next time the integrator runs.


Note: If you are on Halo versions prior to v2.174 the alert in Atera will be deleted rather than resolved when the ticket is closed in Halo. 




Popular Guides