Skip to main content
All CollectionsIntegrationsPSA Integration Guides
Halo PSA - Installation Instructions
Halo PSA - Installation Instructions
Updated over a week ago
  1. 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.

    1. Companies: You can map companies between SO and Halo and sync from from Halo into SO

    2. Company Types: You can map company types between SO and Halo and changes in Halo will update SO.

    3. 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).

    4. Configurations Status: Syncs from Halo

    5. Configuration Types: Syncs from Halo

    6. Configurations (Assets): Syncs from Halo

    7. Contacts/Managed users: Coming soon

    8. Tickets: Coming soon

    9. Projects: Coming soon

    10. Agreements: Coming soon

    11. Opportunities: Coming soon



  2. Halo, create API Agent

    1. Add API Agent: Menu --> Configuration--> Teams & Agents--> Agents --> New

    2. Username: API SO

    3. 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)

    4. Account Active: Checked, don't uncheck

    5. Is API-only agent: Check

    6. Default team: Infrastructure

    7. Working hours: Default

    8. Open API Agent, navigate to "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

  3. Halo, add Application for connection:

    1. Menu --> Configuration--> HaloPSA API--> View Applications

    2. New:

      1. Application name: StrategyOverview

      2. Application method: Client ID and secret

      3. Allow agent logins: check

      4. 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)

      5. Login type: Agent

      6. Agent to log in as: API SO (select from dropdown)

      7. Save: click

      8. 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

  4. Add Integration in Strategy Overview

    1. Add Integration: Settings --> Integrations --> Add Integration --> Halo
      Note: only one PSA integration allowed at once.

    2. Access Token URL: this is URL you use to login to your Halo account

    3. Client ID: This is the key from the API application you just created

    4. Client Secret: This is the key from the API application you just created

    5. Add Integration

  5. Company Types

    1. Enable bi-directional Company Types sync:

      1. Check for full sync - all list of Types will be always updates:
        Map Companies: Map company types strategically. Halowill overwrite anything you mapped. For example. If in Strategy Overview you call clients "Client" and in Haloyou call them "Customer", when you map Customer to Client it will update Strategy Overview to "Customer" when you save the mapping

        Create UnMapped button: Click (This will create all Halo Company Types in Strategy Overview and automap.)

        Save

      2. Or skip the step - to sync only Types which will come with mapped companies.

  6. Company Statuses

    1. Enable bi-directional Statuses sync with Halo: Check

    1. Map Statuses: Halo has only two statuses : active and Inactive (checkbox on Customer's card).

    2. Create UnMapped button: Click (This will create all Halo Company Statuses in Strategy Overview and automap)

    3. Save

  7. 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.

    1. Import Companies (button on the right part of the table): Click

    2. 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.

    3. Company Statuses: Usually you only want to import Companies that are Active

    4. Integration Status: All

    5. 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.

    6. Save Mapping

  8. Configurations

    1. Enable sync Configurations with Halo: Check

    2. Fields Selection tab:

      1. Fields to download: Check all fields you want to bring into SO

      2. 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:

        1. Serial number

        2. Notes

        3. Purchase date: We use Purchase date to count Age in SO. If you don't have Purchase date, you can use Install Date.

        4. 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.

        5. RAM

        6. OS Type

        7. 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.

      3. Save mapping: click

      4. Configuration Selection: This is the place where you can select filters for Assets you want to bring into SO.

        1. Mapped Companies: select "All" (means all assets from all companies will be added in a feature, even if you map new companies).

        2. Types: select asset types you want to bring into SO (Servers, Workstations etc.)

        3. Statuses: we recommend to select only "Active"

      5. Import configurations: Click

  9. 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.

    1. Create Template Configuration: This is the template your configurations will be associated with.

    2. Add

    3. 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.

  10. Classes
    Classes are types of configurations. Examples are:
    Managed Workstations
    - Basic
    - Premium
    - Engineering

    1. Open Classes: Classes Tab/Select Configuration Type (Example: Managed Workstation)

    2. Create Class: Click and name the class (Example: Basic)

    3. Budget: Set budgets (You can select an approximate budget for the hardware, setup and onsite charges if your MSP bills that.

    4. Other Classes: Create any other classes that are useful. Other examples are form Firewall (1-10 Users, 11-20 Users, 21-40 users, etc)

  11. Configurations Template Settings

    1. Open Settings: Template Settings Tab/Click template name

    2. Configuration Types: Only select those that are relevant for asset tracking to show in build mode or Display Mode

    3. Configuration Status: Only select those that are relevant for asset tracking to show in build mode or Display Mode

    4. 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.


  12. Create your first report!

    1. 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.)

Did this answer your question?