HaloPSA Integration
- Sneha B A (Unlicensed)
- Vrushali
- Vrushali Parkar
This is a commonly used & easy to set-up PSA Integration supported by CyberCNS.
Using CyberCNS PSA integration capability, tickets can be raised for suggested remediations from CyberCNS.
Some of these screens are likely to change as we continue adding more features.
Select Integration
Navigate to Global Settings() > Integrations and choose Halo PSA from the integrations listed.
It will lead you to a page where you can add credentials for Halo PSA Instance. Please provide details as requested.
Enter Credentials
Enter Credential Name: Choose a name of your choice for the credentials to be added.
Enter Client ID: Enter a Halo PSA Client ID for the credentials to be added.
Enter Client Secret: Enter a Halo PSA Client Secret for the credentials to be added.
Enter Domain: Enter the Halo PSA Domain name for the credentials to be added (Please do not include https & /api at the end of the domain name while adding the credentials into HaloPSA).
Enter Tenant Name: Enter the Halo PSA Tenant name for the credentials to be added.
6. Enter Authorisation Server: Enter the Halo PSA Authorisation Server for the credentials to be added
(Please do NOT include https while adding the credentials in HaloPSA).
Once all the details above are provided, SAVE the data. Likewise, you can add multiple credentials in this section using the '+' sign.
Under the Halo PSA click on API Details here we will get the Details about the Resource Server, Authorisation Server, and Tenant Name.
Default Template
When the credentials are added, an option to add the Default Template is seen.
Instead of selecting each time for ticket creation in Integration action, we can add a default template here for a particular integration.
In the Default template, choose the Select SLA for Ticket Creation, Priority for Ticket Creation, Ticket Type for Ticket Creation, Status for Ticket Creation, Status for Ticket Close, Team for Ticket Creation, Agent for Ticket Creation, client for Ticket Creation, user for Ticket Creation, Category for Ticket Creation, Urgency for Ticket Creation, Impact for Ticket Creation.
Click on Save once all the fields are selected.
When the template is added successfully, under the credentials section next to the credential name will get a green tick mark().
How to fetch the details of Halo PSA:
Please make sure NOT to use https in the Domain name and Authorisation Server while adding Halo PSA credentials.
Do not add tenant name → It is only for cloud-hosted deployment and not for On-Premise or self-hosted HaloPSA deployments.
For Client ID and Client Secret: In HaloPSA, navigate to Configuration → Integrations → HaloPSA API. Choose View Integrations, then click on "New".
Application Name: Enter a relevant, such as a company name without spaces. Client ID and Client secret will be displayed by choosing Authentication Method as Client ID and Secret(Services).
If all permissions under permissions are enabled, select the client under the details agent to log in Please select the Agent here.
To add an Agent into the team click on Departments and Team and Click on Add button.
After clicking on the Add button add the agent to a team.
If the particular agent is not added to the team, the selected team for Ticket creation will not be created.
Click on save.
Â
For the client permissions please provide below mentioned access to allow the creation of the tickets.
Please set all: standard parameters under permissions as Yes.
Domain Name: Navigate to Configuration > Integrations > HaloPSA API > Resource Server will be the domain name(Copy the Domain Name to add to the CyberCNS Halo PSA Integration).
Please make sure NOT to use https in the Domain name and Authorisation Server while adding Halo PSA credentials.
Tenant name: Navigate to Configuration > Integrations > HaloPSA API > Tenant (Copy the Tenant Name to add into the CyberCNS Halo PSA Integration).
Do not add tenant name → It is only for cloud-hosted deployment and not for On-Premise or self-hosted HaloPSA deployments.
Authorisation Server: Navigate to Configuration > Integrations > HaloPSA API > Authorisation Server (Copy the Authorisation Server to add into the CyberCNS Halo PSA Integration).
The next step is to map local companies in CyberCNS to Halo PSA companies corresponding to the selected domain.
Company Mapping
In Company Mapping, there are three rules to be set. Those are Event Set, Integration Profile, and Manage Company Mapping.
Under the Event Set, click on +Add to add the Alert Rule.
Here a set of Events is to be set to get notified on. Those events are categorized under Agent, Company, Asset, Ports, Remediation, and AD Audit.
Enter the Event Name and select the category of an Event as required.
Every Category has a set of events/alerts under them which needs to be selected as per requirement.
e.g. Asset category has below-listed alerts and selection of all or any is allowed.
The Ports category, has the below-listed alerts, and the selection of all or anyone is allowed.
For the Remediation category, selection of any one of the listed, Remediation by Company OR Remediation by Assets OR Remediation by Product, Remediation by Asset and Product is allowed.
To Enable Tickets for Remediations based on EPSS, one of the below-listed events is to be selected from the Remediation Group and then select an event from Remediation Filters.
Enable Remediation for Critical and High Severity can enabled as additional Remediation Filters.
For the Vulnerability & Azure error category, the below-listed alert, and selection is allowed.
For the AD Audit category, the below-listed alerts are available and selection of all or any is allowed. (Make sure to select the needed as it will create tickets based on the events).
For the Azure AD Audit and Unquoted service path category, the below-listed alert, and selection is allowed.
For the Reports, the below-listed alerts and selections are allowed.
Choose the listed events to set up CyberCNS Alerting as required.
Choose the Vulnerability alerting events that should be notified on selected channels.
Once the above details are provided, click on Save.
There is an option to Edit, Delete, and Set as default for the Notification Rules using the Action column. The listed Notification Rule can be edited and deleted as needed.
For setting the created Event as default, select the option Set as Default.
To confirm the Set as a default action, select Yes or No in the confirmation dialogue box.
Once the event is set to default, under Is Default column the status can be seen.
Integration Profile
Users will be able to set notification rules from integrations right away for conditions listed under it.
Under the Integration Profile, click on +Add to add the Integration Rule.
Enter the Name, Select the credential, and fill out all of the required fields in the Integration Parameters.
Once the below details are provided, click on Save.
There is an option to Edit, Delete, and Set as default under the Integration Rules using the Action column. The listed Integration Rule can be edited or deleted as needed.
For setting the newly created Event as the default, select the option Set as Default.
To confirm the Set as a default action, select Yes or No in the confirmation dialogue box.
Manage Company Mapping
Click on Manage Company Mapping.
Choose Halo PSA Credentials from the dropdown and click on + Add to add Integration Mapping.
In New Company Mapping, choose the Halo PSA Credential which is listed. (These are to be added under the Credentials section for Halo PSA).
One of these two options could be selected
Import Companies from Halo PSA:- To import multiple companies listed under Halo PSA to CyberCNS at a time.
Map Existing Company to a Halo PSA company:- To map an existing company in CyberCNS to the existing company under Halo PSA company.
To import multiple companies from Halo PSA, choose Import Companies from Halo PSA, and click on Next.
As per the below image, the company can be searched using the search option given.
The Page Size shows the rows per page that can be displayed for search results and the Page shows the number of pages that can be displayed for a search result.
Click on Get Companies to show the list of the companies as requested in the search column.
Once searched as per the choice or the requirement it displays the search result in the Select Companies dropdown.
In case you want to manually search the company, you can simply click on the drop-down of Halo PSA Companies and it will list all companies available under Halo PSA.
when the companies are imported, the names will be created with the selected company name and site_id, which refers to site numbers. here it can also import the same companies but with different site names.
This will allow multiple sites per company to be created as a different company considering multiple sites for a single company.
Once the company is selected, it shows as an additional entry below. It can be deleted or click on Next to proceed further.
when the companies are imported, the names will be created with the selected company name and site_id, which refers to site numbers.
Click on the checkbox to enable Create Ticket. This is create a ticket with PSA for selected events.
To enable the pushing asset configuration to PSA, need to Enable configuration under the integration company mapping.
From the dropdown select the event set and Integrate Profile and click on button to add the event set and integration profile.
Once the Event Set, Integration profile is selected click on ‘Add' to select the company and click on Next.
Now click on Finish to import all the selected Halo PSA companies. This completes importing companies from Halo PSA.
Click on +Add and select Map Existing Company to Halo PSA company to add map existing company and click on Next.
As shown in the below image, select the Local company( CyberCNS) and HaloPSA company by using a dropdown or with the search bar as per the requirement so it will map the companies accordingly.
when the companies are imported, the names will be created with the selected company name and site_id, which refers to site numbers.
Click on the checkbox to enable Create Ticket.
To enable this configuration, need to Enable configuration under the integration company mapping.
From the dropdown select the event set and Integrate Profile and click on button to add the event set and integration profile.
Once the company is selected click on ‘Add' to select the company.
Once all the fields are provided, click on Finish.
Selected companies are shown in the image below, along with details such as Existing Company Name, Company Name, and Mapped Date.
Here click on Copy Settings to Copy the company mapping settings to other company mappings.
To copy settings, select the desired company mappings and click on Update. This will copy the event set, integration profile, and ticket creation fields from the source company mapping to the selected target company mapping.
Using the Action column, you can edit and delete the integration mapping. Any mapping can be removed if necessary.
Click on Edit to update Company mapping.
This completes the documentation of Halo PSA Integration.