Halo Service Desk Guides
Documentation to assist with the setup and configuration of the Halo Service Desk platform
Ninja RMM Integration (API V1)
Ninja RMM Configuration
This integration requires some Ninja RMM configuration before the integration configuration can be completed in the Halo Application.
Note: The following API key generation is for Ninja API V1 - steps for API V2 key generation coming out soon.
To communicate with Ninja RMM via its API, an Access Key must be generated in Ninja RMM. To do this, go to Configuration > Integrations. Your current list of API Keys will be listed on this page. To register a new API Key, select the Generate API Key option in the top right corner of the page.
Give your key a sensible name, and ensure you make a note of the secret, as you will not be able to obtain this value again after leaving the screen.
The following configuration must be carried out in Halo in order to facilitate the integration.
To enable the Ninja RMM 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.
There are three initial options that must be completed. The first option is the location field. This is the location where your Ninja RMM instance is hosted. For example, if you access Ninja via https://eu.ninjarmm.com/ , then you should choose Europe as the location.
The second and third options require you to key in the details of Access Key that you generated earlier in this guide.
It is possible to import Customers from your Ninja RMM instance. This is not a required step, and can be skipped if you do not wish to do this. For those of you that do wish to import your customers, there are two options to consider.
The first is the Top level that you would like Customers imported from Ninja RMM to be assigned to. Please note that this field will only display if you have enabled top levels in your Halo Application.
The second option gives you the choice to match existing Customers in your Halo database to Customers being imported from Ninja RMM via their name. The Ninja RMM ID of the Customer which gets assigned during the initial import will always be checked first, so this feature will only be useful during the first Customer import from Ninja RMM and if you already have your Customer list in the Halo database.
As there is minimal Customer information that can be retrieved from Ninja RMM, it is not possible to map fields for Customers in this integration. Once you’re happy with your configuration, hit the Import Customers button to load your Customer list from Ninja RMM into the import screen. You can deselect any unwanted Customers from the list before the import, but please be aware, if you are importing Customers via the Halo Integrator, the entire Customer list will be imported. Click the Start button to begin importing your chosen Customers.
It is also possible to import Assets from your Ninja RMM instance. Before we move onto field mappings, there are three options to consider.
The first option allows you to choose a default site for Assets. This is particularly important if you have not imported your entire Customer list from Ninja RMM. All Assets must be associated with a Site in Halo, therefore, if the imported Asset’s Ninja RMM Site/Customer cannot be found because it hasn’t been imported, the Halo Site will be set to the default value that you specify here.
Next you must choose a Default Group that any new Asset Types will be created under. There are 4 Asset Types in Ninja RMM – AGENT, MONITOR_SERVER, NMS_SERVER and NMS_TARGET. When importing an Asset, if an Asset Type does not exist with the same name as the Type from Ninja RMM, one will be created for you automatically, and it will be assigned to this group.
Finally, you have the option to choose an Asset field that should be used to match new imported records to existing records. Again, the Ninja RMM ID of the Asset which gets assigned to the Asset on it’s first import is always checked first, so this field is only useful/required if you already have your Asset list in Halo, and you’re importing from Ninja RMM for the first time.
IMPORTANT: if you are using this field, the Asset field that you choose must exist as a field mapping. These are configured in the next section.
It is possible to map Ninja RMM Asset Fields to both Halo Asset Fields and Halo Custom Fields. To add a new field mapping, press the plus icon in the top right corner of the field mapping table. This will display an input screen with three options.
You should first choose whether you would like to map to an Asset Field, or a Custom Field. Custom Fields must be created before you can create a mapping to them. For Asset Fields, there is an extra option that can be chosen which will create you a new field during the next import. Each Ninja RMM field can only be mapped once. When imported, the Assets field value from the Ninja RMM field will be saved to the Halo Field that you have mapped it too for that Asset.
Once you’re happy with your configuration, click the Import Assets button to load you Asset list from Ninja RMM into the importer screen. Just like the Customer import, you can deselect any Assets you do not wish to import before commencing with the import, however, when importing from halo Integrator, all Assets will be imported. Hit the Start button to begin the import.
As with all RMM tools, it is possible to have email alerts sent to a mailbox when a problem is detected with an Asset. To process these alerts and assign them to the correct Assets, add an email rule by completing the 'From Address' and 'Ticket Type for new Alerts'. You can also add your Ninja RMM alert types by clicking the button to take you to the alert type list.
When an Asset is imported into your Halo database, each Asset will be assigned a Ninja RMM Url. When viewing the Asset in Halo, a button will be displayed at the top of the Asset allowing you to open the Asset in Ninja RMM in a separate browser tab.
If you are using Remote Control i.e. TeamViewer in Ninja RMM, the import will assign another url to each Asset. This url is a shortcut to start the remote control for this Asset. If the Asset has the remote control url, a separate button will also be displayed next to the button highlighted above to initiate this.
Once you’re happy with your configuration for the rest of the integration, you can then enable the Halo Integrator application to run the imports for you.
The Halo Integrator can be downloaded using the link provided. You can also choose whether to automatically import Customers and/or Assets. Each time Halo Integrator imports from Ninja RMM, the last sync date and the last error (if there was one) will be saved to the database so that you can view them within the Halo Web Application.
Once you’ve downloaded the Halo Integrator, you should complete the configuration check on the Ninja RMM tab. General configuration of the Halo Integrator is not covered in this guide.
If all points return with a green ticket, then you are ready to import. If any points return a red cross, you should revisit the configuration for the integration.
To manually import via the Halo Integrator, switch to the Processes tab and click “Start Processing”. This will process all integrations that are enabled for the Integrator.
Alternatively, if your Halo Integrator application is already configured to run on a schedule, the Ninja RMM integration will be checked and processed the next time the Integrator runs. Even if you do not want to import manually within the Halo Web application, it is still recommended that you click the Import Customers/Assets buttons to check that you are happy with your field mappings and that there are no connection issues to Ninja RMM, before proceeding with an import via the Halo Integrator.
- Asset Import - CSV/XLS/Spreadsheet Method
- Call Management in Halo
- Creating Agents and Editing Agent Details
- Departments, Teams and Roles
- Importing Data
- Multiple New Portals with different branding for one customer [Hosted]
- Organisation Basics
- Organising Teams of Agents
- Step-by-Step Configuration Walk Through
- Syncing Exchange Calendars