Halo Integration Overview
The Halo integration is designed to create a sync of key Company information to allow you to run reports on important metrics in your MSP.
Here are the areas that we sync.Companies: You can map companies between SO and Halo and sync from from Halo into SO
Company Types: You can map company types between SO and Halo and changes in Halo will update SO.
Company Status: You can map company status between SO and Halo and changes in Halo will update SO (active/inactive flag in Halo equals to Active/Inactive status in SO).
Configurations Status: Syncs from Halo
Configuration Types: Syncs from Halo
Configurations (Assets): Syncs from Halo
Contacts/Managed users: Syncs from Halo
Tickets: Coming soon
Projects: Coming soon
Agreements: Coming soon
Opportunities: Coming soon
Allowlist IPs
If your Halo environment can only connect to allowed IPs please allow list the following IPs
52.247.76.89
52.247.76.111
52.247.76.163
52.247.76.166
52.247.76.170
52.247.76.201
20.49.97.4
Halo - Create API Agent
Add API Agent: Menu > Configuration > Teams & Agents > Agents > New
Username: API SO
Email address: Address you have access to (email must be unique within Halo database, so you want be able to use the same email for API-agent and regular agent)
Account Active: Checked, don't uncheck
Is API-only agent: Check
Default team: Infrastructure
Working hours: Default
Open API Agent > "Permissions" tab > click "Edit" > Setup Permissions:
Customers Access Level - Read Only
CRM Access Level - Read Only
Assets Access Level - Read And Modify
Users Access - Read Only
Products Access Level - Read Only
Halo - Add Application for connection
Menu > Configuration > HaloPSA API > View Applications
New:
Application name: StrategyOverview
Application method: Client ID and secret
Allow agent logins: check
Copy Keys: Copy your Client ID and Client Secret.
(Once you leave this page you wont be able to see the Secret again.
You can always add a new API Key to reenable the integration)Login type: Agent
Agent to log in as: API SO (select from dropdown)
Save: click
Give permissions: "Permissions" tab, click "Edit"
Select "All standard" OR only the following:admin: webhooks
read: customers
edit: customers
read: crm
edit: crm
read: software
edit: software
read: assets
edit: assets
Add Integration in Strategy Overview
Add Integration: Settings --> Integrations --> Add Integration --> Halo
Note: only one PSA integration allowed at once.Access Token URL: this is URL you use to login to your Halo account
Client ID: This is the key from the API application you just created
Client Secret: This is the key from the API application you just created
Add Integration
Company Types
Enable bi-directional Company Types sync:
Check for full sync - all list of Types will be always updates:
Map Companies: Map company types strategically. Halo will overwrite anything you mapped. For example. If in Strategy Overview you call clients "Client" and in Halo you call them "Customer", when you map Customer to Client it will update Strategy Overview to "Customer" when you save the mappingCreate UnMapped button: Click (This will create all Halo Company Types in Strategy Overview and automap.)
Save
Or skip the step - to sync only Types which will come with mapped companies.
Company Statuses
Enable bi-directional Statuses sync with Halo: Check
Map Statuses: Halo has only two statuses : active and Inactive (checkbox on Customer's card).
Create UnMapped button: Click (This will create all Halo Company Statuses in Strategy Overview and automap)
Save
Companies
Its best practice to import only Managed clients that are in active Strategic Planning. You do not want to clutter SO with all potential leads, vendors, etc.Import Companies (button on the right part of the table): Click
Types: Please select the type used for your Managed Clients. Strategy Overview accounts can have unlimited users but are limited by number of Managed Clients in the system used for Strategic planning. This allows us to provide fair pricing for any MSP at any size.
Company Statuses: Usually you only want to import Companies that are Active
Integration Status: All
Load Companies: Click Load Companies and select Companies you want to Import into the system to use for strategic planning. If you already had companies in Strategy Overview and they had the exact same company name, it will automatically map. If you did not, you need to press "Create unmapped" to create them in SO.
Save Mapping
Configurations
Enable sync Configurations with Halo: Check
Fields Selection tab:
Fields to download: Check all fields you want to bring into SO
Fields to map: Map your Halo fields with SO fields to use all SO features. System shows in dropdown only fields you have selected in "Fields to download" section:
Serial number
Notes
Purchase date: We use Purchase date to count Age in SO. If you don't have Purchase date, you can use Install Date.
Expiration date: We need this field to update Expiration date for asset by our Warranty Service in Your PSA. Sync back option disabled by default, you can select if you want to update this data or not later during Warranty Service setup.
RAM
OS Type
Manufacturer Name
Please, map all required fields. If you don't see needed field in mapping dropdown, then
1) make sure you have chosen them in "Fields to download"
2) you can add needed fields in Halo: Configuration --> Asset Management --> Asset fields --> New:
- Field label: Input.
- Type of filed: select.
- System use: No system use.
Save: click.
Save mapping: click
Configuration Selection: This is the place where you can select filters for Assets you want to bring into SO.
Mapped Companies: select "All" (means all assets from all companies will be added in a feature, even if you map new companies).
Types: select asset types you want to bring into SO (Servers, Workstations etc.)
Statuses: we recommend to select only "Active"
Import configurations: Click
Configuration Settings
This is the place where you define rules for your configurations.
You can find configuration settings using two ways:
1) Settings - Configurations
2) Settings - Integrations - Open integration - Configurations - Configuration Selection - "Configurations settings" button.Create Template Configuration: This is the template your configurations will be associated with.
Add
Grades: Review the default grades that come with the system. Grades allow you to grade configurations and identify which are healthy and which need to be upgraded/retired.
Classes
Classes are types of configurations. Examples are:
Managed Workstations
- Basic
- Premium
- EngineeringOpen Classes: Classes Tab/Select Configuration Type (Example: Managed Workstation)
Create Class: Click and name the class (Example: Basic)
Budget: Set budgets (You can select an approximate budget for the hardware, setup and onsite charges if your MSP bills that.
Other Classes: Create any other classes that are useful. Other examples are form Firewall (1-10 Users, 11-20 Users, 21-40 users, etc)
Configurations Template Settings
Open Settings: Template Settings Tab/Click template name
Configuration Types: Only select those that are relevant for asset tracking to show in build mode or Display Mode
Configuration Status: Only select those that are relevant for asset tracking to show in build mode or Display Mode
Configuration Columns: These are the columns that display for the Assets tab. We preconfigured them to show just the right information you may want to show. You can always edit these later. Please note, by default we do not enable recurring budget columns for Assets. If your MSP sells/leases/rents computers on a monthly basis you can enable that.
Create your first report!
Create Report: Companies module/Find the client you want to make a report for. (If you already have a draft open, the assets tab will already show. If you only have completed reports, click New Report icon next to the company name to make a new report.)
Updated over a month ago