HaloPSA plugin

Visualize your HaloPSA data by showing clients, tickets, quotes, invoices, report data and assets on dashboards.

Click the following link for additional content such as blogs, videos, use cases, and more:

HaloPSA

Adding a data source

To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page. Adding from the data sources page

Before you start

1. Decide which authentication method to use.
   The HaloPSA Agent and Application are configured differently for each. SquaredUp supports two authentication methods:
   • Client credentials using Client ID and Secret (Recommended)
   • Basic using Username & Password
2. Configure an Agent in HaloPSA
3. Register an application in HaloPSA
4. Configure the data source in SquaredUp

Configuring an Agent in HaloPSA

The Agent will need permissions for what you want SquaredUp to show. The Agent is used with both methods of authentication.

1. Log in to HaloPSA as an administrator.
2. Navigate to Configuration > Teams & Agents > Agents.
   This will take you to:
   https://<companyName>.com/config/agents/agents
3. Click +New
4. Details tab:
   Complete the mandatory elements of the form: Username, Default Team, and Work Hours.
   The Default Team chosen will affect which tickets SquaredUp can show. Alternatively, you can configure the Agent to be able to view all tickets using settings on the Permissions tab as detailed below.
   

   Is an API-only Agent:

   You may like to tick Is an API-only Agent if you are going to use Client credentials using Client ID and Secret as the authentication method, because API-only Agents do not consume a HaloPSA licence.

   If you are using Username & Password authentication, then Is an API-Only agent should be unchecked.

5. Click Save.
6. Click Edit.
7. Click on the Permissions tab:
   Under Feature Access configure Read Only permissions for the information you want to display. You must give read access to customers, but any additional permissions you configure will depend upon what you'd like to show in SquaredUp:
   
   • read:customers (mandatory)
   • read:tickets
   • read:quotes
   • read:invoices
   • read:reporting
   • read:assets

   If you have edited permissions to get data to show on a dashboard, you will need to Edit your HaloPSA data source and click Test and update, then refresh the tile on your dashboard.

   Optionally, you may also wish to set further Agent permissions if tiles are unexpectedly showing No data. For example, for tickets:
   Permissions tab: Can view Unassigned Tickets: yes

   Permissions tab: Can view Tickets that are assigned to other Agents: yes

   Departments & Teams tab: Membership level to all Departments: View all (Can view all tickets in all Departments)

   See Halo: Agents Guide

8. Click Save.

Registering an application in HaloPSA

Registering the application generates the client credentials needed to configure the data source in SquaredUp. The application will need permissions for what you want SquaredUp to show (along with the Agent permissions).

1. Log in to HaloPSA as an administrator.
2. Navigate to Configuration > Integrations > HaloPSA API > View Applications.
   This will take you to:https://<companyName>.com/config/integrations/api/applications
3. Click +New
4. Details tab:
   1. Application Name:
      Enter a name for the registered application. For example, SquaredUp.
   2. Authentication Method:
      Choose the authentication method you prefer. We recommend using a client id and secret, but we also support username and password.
      1. Select Client ID and Secret (Services)
         1. Copy the Client Secret and save it somewhere safe.
         2. Leave the Login Type as Agent.
         3. On the Agent to log in as drop down list select the Agent you created earlier.
      2. If you prefer, you might want to use Username & Password.
         1. Select Username & Password.
         2. Ensure Allow Agent Logins is selected.
5. Permissions tab:
   Configure permissions for the information you want to display. You must give read access to customers, but any additional permissions you configure will depend upon what you'd like to show in SquaredUp:
   
   • read:customers (mandatory)
   • read:tickets
   • read:quotes
   • read:invoices
   • read:reporting
   • read:assets

   If you have edited permissions to get data to show on a dashboard, you will need to Edit your HaloPSA data source and click Test and update, then refresh the tile on your dashboard.

6. Click Save to register the application. It is added to the list on the Applications page.

Configuring the data source

1. Display name:
   Enter a name for your data source. This helps you to identify this data source in the list of your data sources.

2. HaloPSA server URL:
   The address where your environment is located. You'll see this in the address bar of HaloPSA, usually in this format: https://yourcompany.halopsa.com
3. Authentication:
   1. If you chose Client ID and Secret in HaloPSA, then select Client credentials in SquaredUp:
      1. Client id:
         Enter the Client id for the application you registered in HaloPSA.
      2. Client secret:
         Enter the Client secret for the application you registered in HaloPSA. If you forgot to save it you can Generate it again in HaloPSA.
   2. If you chose Username & Password in HaloPSA, then select Basic in SquaredUp:
      1. Client id:
         Enter the Client id for the app you registered in HaloPSA.
      2. Username:
         Enter the username of your HaloPSA Agent (not the email address). This must be an Agent, not a User.
         

      3. Password:
         Enter the password for the Username you entered.
4. Specific tenant:
   The tenant will be automatically extracted from the server URL (e.g. 'company1' from 'https://company1.halopsa.com'), but you can manually specify a tenant ID by checking this option and entering a tenant id in the box.
   The tenant can be found in HaloPSA from Configuration > Integrations > HaloPSA API

5. Restrict access to this data source:
   Optionally, enable this toggle if you only want certain users/groups to have access to the data source, or those with the permission to link it to new workspaces. See data source access control for more information.

6. Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.

   Testing outcomes

   • Testing passed – a success message will be displayed and then the configuration will be saved.
   • Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
   • Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.

   You can edit data source configurations at any time from Settings > Data Sources.

Testing and troubleshooting

Next Steps

Now that you have successfully added the data source you can create dashboards, view the data streams, or explore any indexed objects.

Dashboards

A number of pre-built dashboards can be installed for this plugin. These dashboards can be adapted for your own use by copying them to the Dashboards folder. Some dashboards use dashboard variables, so you should start by selecting the object that you're interested in from the dashboard variable dropdown list.

Data streams

You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.

The following data streams are installed with this plugin.

Example tile configuration

There are many different types of tile you can create, here are just a few examples to get you started.

Open tickets by customer donut

Open tickets by team bar chart

Ticket Feedback Score

Was this article helpful?