Introduction
This guide outlines the steps to integrate HaloPSA with the CyberQP, enabling seamless use with the Service Desk/Ticket functionality. With this integration, you can take action directly in HaloPSA with your PSA Contacts or Directory Accounts, including:
- Verifying your end-user accounts
- Resetting passwords
- Sending password reset links
- Enabling/Disabling directory accounts
Additionally, we have support for matching end-user accounts from a directory to a PSA, creating a consolidated data source view directly within Halo. This feature simplifies account management by ensuring consistency between your directory and PSA systems.
To further enhance efficiency, we have a global end-user accounts search bar that allows you to quickly locate PSA contacts or directory accounts
Prerequisites
Before proceeding, ensure you have the following:
-
- An active HaloPSA subscription.
- An active CyberQP subscription that include access to manage End-User accounts (QDesk).
- A login to your Halo tenant with Admin Role permissions.
- Primary or Super role technician access to your CyberQP tenant
General High Level Steps
- Create a new API-only HaloPSA user for CyberQP
- Create a new API Application in HaloPSA
- Configure the HaloPSA Integration in CyberQP
- Configure the CyberQP Tab to appear inside tickets
Steps
Create a new API-only user for CyberQP
- Log into Halo PSA > In the sidebar click "Configuration"
- In the search bar type "Agents"
- Click on the "Agents" Icon
- Click the "New" button near the top right of the screen
- In the "Username" field. Enter "CyberQP Integration"
- In the "Roles" field, click and select "Administrator"
- Click the checkbox for "Is an API-only Agent"
- Scroll to the bottom of the page and click the "Save" button (HaloPSA will signal to you all other required fields you need to fill out to save the user. Please fill those out according to your HaloPSA setup)
Create a new API application in HaloPSA
- In the sidebar click "Configuration"
- In the search bar type "HaloPSA API"
- Click on the "HaloPSA API" Icon
- In "API Detail" Record the "Resource Server" value without the directory "/API" into a temporary note on your computer
It will be presented like this in HaloPSA https://{yourhaloaddress}.halopsa.com/api
You will save this to your temporary notes as https://{yourhaloaddress}.halopsa.com - In "API Detail" Record the "Tenant" value into your temporary note
It should look something like mymspname
- In the "Applications" section > Click "View Applications"
- On the top right click the "New" Button
- In "Application Name" > Enter "CyberQP"
- In "Authentication Method" > Click "Client ID and Secret (Services)"
- Record the "Client ID" value into your temporary note
- Record the "Client Secret" value into your temporary note
- Ensure "Login Type" is set to "Agent"
- In "Agent to login as" > Click and type to search the API user you created previously (EG: "CyberQP Integration")
- Scroll to the top and click the "Permissions" tab
- Click the following permissions:
"All"
"All:Teams"
- Save your Changes
Configure the HaloPSA Integration in CyberQP
- Login to the CyberQP dashboard at https://admin.getquickpass.com (North American Datacenter) or https://eu-admin.getquickpass.com (Europe Datacenter) with your technician that has the primary or super role.
- In the sidebar, click "Integrations"
- Click the "HaloPSA" tile
- Using the information on your temporary file, populate the following:
Account URL (Resource Server from Halo PSA)
Tenant
Client ID
Secret (Client Secret from HaloPSA)
NOTE: If your an on-premise customer, enter any arbitrary value into the tenant field as their is no concept if a tenant value for on premise HaloPSA setups. (EG: you may enter the word "selfhosted" to continue)
- Click the "Connect" button
- If all goes well, you should be taken to the "Customers" page. Click the "Settings" button to configure your field mapping settings for syncing with HaloPSA.
The Integration Settings pop up will allow you allows you to select a PSA email and phone number field to sync with CyberQP for sending welcome emails, notifications, and authentication requests, ensuring automated updates whenever contact details change in the PSA.
Any future updated will change the email address and phone number we have on file for your end-user.
It will also affect the email address and phone number they use to log into the mobile self serve app and the the web base self serve portal.
- Once you set the Email and Phone number to a field mapping setting you want. Click the Save button. For more information please see HaloPSA to CyberQP Data Sync FAQs
- Now Click "Match Customer" to begin matching your customer with HaloPSA.
- You'll now be presented with a list of Halo companies in alphabetical order, and you'll have 2 options for matching, which are detailed below. You can also create a customer from this list.
Warning: Please ensure the "Relationship" and "Main Site" fields are correctly filled out in HaloPSA for each client to maintain accurate synchronization. Your clients on HaloPSA need this filled out and established to make sure they are presented for customer matching.
Option 1 (Automatic Matches)
Items marked with a three-star icon have been automatically matched, indicating an exact spelling match between a customer in CyberQP and Halo.
Use the "Suggested Matches" option within the "Match Status" filter to easily identify CyberQP customers that have been automatically matched.
Option 2 (Manual Matching)
Accounts not automatically matched can be manually linked with your CQP tenant.
-
Using Filters: Utilize the filters at the top to display Halo Clients without an exact spelling match to a CQP Customer.
-
Match Status Filters:
- All: Displays all Halo Clients, regardless of matching status.
- Unmatched: Shows Halo Clients that do not have an exact spelling match to any CyberQP Customer
-
Matched: Displays all Halo Clients that you have assigned a matching status on this screen.
To define a manual match, click the "Match with CyberQP Customer" box, select the appropriate CyberQP customer, and then click the select button.
Option 3 (Create CyberQP Customers)
You also have the option of creating new customers in CyberQP, based on your existing Clients in HaloPSA. For this, simply check the box next to the customers you'd like to generate inside CyberQP, then click Save.
-
Using Filters: Utilize the filters at the top to display Halo Clients without an exact spelling match to a CQP Customer.
- You may now proceed to match end-user accounts on CyberQP with HaloPSA end-users
Configure the CyberQP Tab to appear inside tickets
1. Navigate to Configuration > Tickets
2. Click on "Ticket Types" to view all the ticket types and click on any desired ticket type where you want the CyberQP integration to display inside
3. Click on "Allowed Values" tab and then select "Edit"
4. Navigate to "Custom Tabs" section and click on "+" icon to add the "CyberQP" tab. Click on "Save".
Comments
0 comments
Article is closed for comments.