HaloPSA plugin

Monitor the tickets, assets, clients and reports for your HaloPSA environment.

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.

Before you start

Before configuring the plugin in SquaredUp you'll need to have first registered an application in HaloPSA. This will generate the client credentials required to add the plugin in SquaredUp.

Registering an application in HaloPSA

Log into HaloPSA as an administrator.
Navigate to Configuration > Integrations > Halo API.
Click View Applications to access the Applications page.
Click New and configure the following on the Details tab:
1. Application Name:
  Enter a name for the registered application. For example, SquaredUp.
2. Authentication Method:
  Select Username & Password.
3. Credential Type:
  Select Username & Password.
4. Allow Agent Logins:
  Ensure this checkbox is selected.
Click Save to register the application. It is added to the list on the Applications page.

Configuring the data source

Display name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.
Enter the following details for your HaloPSA instance. These can be found by navigating to Configuration > Integrations > HaloPSA API.
1. HaloPSA server URL:
  The address that your environment is located. This is typically unique to your organization and follows this format: https://yourcompany.halopsa.com.
2. Tenant ID:
  The unique identifier for your organization's HaloPSA environment.
Client ID:
Enter the Client ID for the app you registered in HaloPSA.
Username:
Enter the username of your HaloPSA account.
Password:
Enter the password for the Username you entered.
Scope:
Specify the access scopes to grant when authenticating. The following are recommended:
- read:tickets
- read:customers
- read:assets
- read:reporting
(Optional) Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.
Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
- 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 any data source configurations at any time from Settings > Data Sources.

Next Steps

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

Configurable data streams

The following data streams installed with this plugin have configurable Parameters.

Data stream	Description	Parameters
Assets	Returns a detailed inventory of physical or digital assets associated with a client or organization.	Asset status: Select an asset status to to filter by.
Tickets	Returns your support and service tickets managed within HaloPSA. This data stream is available as both a global data stream and a data stream that is scoped to Client/s.	Ticket status: Select a ticket status to filter by.
Report data	Returns data for a specific report.	Report ID: Enter the ID of a report to return data for. You can use the Report List data stream to look up report IDs. Report parameters: Optionally, enter additional parameters to filter by.
Report List	Fetches a list of all your HaloPSA reports. This data stream is extremely useful for discovering the reports available to you and for finding the ID of a report you want to filter to in the Report Data data stream.	Report Type: Select the type of report to filter by. Search: Specify the name of a report to filter by.
Clients	Returns a list of your HaloPSA clients with related data such as the name, status, type and email.	Client status: Select the status of a client to filter by.

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket