Connect to ConnectWise PSA Cloud
Overview
This article describes how to add cloud-hosted ConnectWise PSA™ (Manage) as a datasource in BrightGauge™, a ConnectWise solution. Before you connect to the ConnectWise PSA Cloud data source in BrightGauge, you must create an API member with a dedicated security role in PSA (Manage).
Create a Security Role in ConnectWise PSA
Security roles enable you to define permissions and access for your PSA members. The PSA integration requires an API member with a dedicated security role to ensure proper access to your data. Please be sure to create the security role and the API member from the PSA desktop application. See details for PSA security modules and their actions at the Security Modules documentation.
To create a security role in PSA:
- Navigate to System > Security Roles.
- Click the New Item icon.
- Enter a Role ID to help you easily identify the new role. For example, BrightGaugeAPI.
- Click Save.
- Assign the Inquire Level > All permission for the following actions. Leave the Add, Edit, and Delete levels set to None.
Note: As the integration is developed, new permissions will be added that are not currently listed here. If you encounter an issue with the integration, please refer back to this table to ensure that all necessary permissions are enabled.
Module Action Companies Company Maintenance Configurations Contacts CRM/Sales Activities Team Members Finance Accounting Interface Agreement Invoicing Agreements Billing Rate Maintenance Billing View Time Company Finance Invoicing Procurement Inventory Adjustments Inventory Transfers Product Catalog Product Billable Option Product Catalog Products Purchase Orders Project Close Projects Project Contacts Project Finance Project Headers Project Management Project Phase Project Product Project Scheduling Project Teams Project Tickets Sales Closed Opportunity Opportunity Opportunity Finance Sales Order Finance Sales Orders Service Desk Close Service Tickets Merge Tickets Resource Scheduling Service Ticket - Finance Service Tickets System API Reports Member Maintenance Member Maintenance - Finance My Company System Reports Table Setup Today Links Time & Expense Expense Billable Option Expense Report Entry Time Entry Time Entry Billable Option - Click Save.
- After you create the security role, you can proceed to create the API member.
Create an API Member in PSA
Note: The PSA integration requires an API member with a dedicated security role to ensure proper access to your data. Please be sure to create the security role and the API member from the PSA desktop application.
To create an API member in PSA:
- Navigate to System > Members.
- Select the API Members tab.
- Click the New Item icon.
- Enter a Member ID and a Member Name, such as BrightGaugeAPI.
- Select the new security role from the Role ID menu.
Note: The Admin role is not recommended for the integration.
- Ensure the the Level field is set to Corporate. This is to ensure that you do not restrict the service boards you see.
- Click Save after completing all fields.
- Click the API Keys tab.
- Click New Item.
- Enter a Description for the key, such as BrightGaugeAPI.
- Click SAVE.
- Copy the Public Key and the Private Key.
Note: The Private Key is no longer visible after the screen is closed. Be sure to save both keys now in a separate, safe location, as you may only view the Private Key at the time it is created.
Connect to Cloud-Hosted PSA
To connect to cloud-hosted PSA from BrightGauge:
- Log in to your BrightGauge account.
- Navigate to DATA > Datasources.
- Click Add a New Datasource.
- Select PSA to filter by PSA applications.
- Select ConnectWise PSA Cloud.
- Enter the following information:
Name A friendly name for your datasource/integration. Site Your ConnectWise PSA site. Refer to the URL you use to log in to PSA. Company ID Your ConnectWise PSA company ID/name. Public Key The API public key you generated in PSA. Private Key The API private key you generated in PSA. Your Locale Your country or region for ConnectWise. This allows for deep linking. - Click Test Connection.
- After a successful connection, click Save. Dashboards, reports, datasets, and gauges are added to your account after the datasource is saved. The sync usually takes 20 to 30 minutes to complete.
Default Resources
BrightGauge provides the following dashboards, reports, and datasets for the hosted ConnectWise PSA datasource.
Default Gauges
For a list of default gauges, select Gauges from the top menu bar in BrightGauge.
Default Dashboards
To locate your dashboards, select Dashboards from the top menu bar, then click the dashboard name to open the dashboard selection menu.
- Agreement KPIs
- BGS - Procurement
- BGS - Projects
- BGS - SLA
- BGS - Service Board
- BGS - Service Desk Leaders
- BGS Sales Board
- Client Dashboard Template
- In/Out Board
- Inventory Dashboard
- Member Efficiency
- Tech Dashboard
Default Reports
To locate your reports, select Reports from the top menu bar.
- Agreement Monthly Review
- BGS - Monthly Project Wrapup
- BGS - Service Desk Leaders
- BGS - Weekly Project Report
- CW Hosted Executive Summary Report
- Member Efficiency - Current Week
- Member Efficiency - Today
- Inventory
Default Datasets
Custom Fields
In BrightGauge, you can utilize the custom fields available in ConnectWise PSA. Please contact BrightGauge Support for any custom field requests. Please create a case in ConnectWise Home or chat with a representative, referencing Add Custom Fields to BrightGauge. For more information on how to create custom fields in PSA, please refer to the Custom Fields Setup Table documentation.
Custom Field Locations in PSA
When you utilize the integration between ConnectWise PSA Cloud and BrightGauge, you can add custom fields in the following locations to BrightGauge:
- Companies - Data for Company setup within PSA. This gives one line per company and has information contained within their company setup. This pulls in all, non-deleted companies.
- Catalog Items - Data for the Product Catalog in PSA.
- Configurations - Data for Configurations in PSA.
- Opportunity - Data for Opportunities updated in the last 365 days.
- Agreements - Data for Agreements entered in PSA.
- Products - Data for Products in PSA.
- Expenses - Data for Expenses in PSA.
- Projects - Data for Projects in PSA.
- Purchase Orders - Data for Purchase Orders in PSA.
- Service Tickets - Data for Service Tickets in PSA.
- Contacts - Data for Contacts in PSA.
- Inventory - Data for Inventory in PSA.
- Invoices - Data for Invoices in PSA.
- Sales Orders - Data for Sales Orders in PSA.
- Time Entry – Data for Time Entry in PSA.
Note: Custom fields on any other screen cannot be added to BrightGauge.
After the ticket is submitted and the request is completed, your custom field data is available to use for analytics and to build gauges that you can add to a dashboard.