Integrating with ConnectWise PSA¶
ConnectWise Professional Services Automation (PSA) is a comprehensive business management platform designed for IT service providers, including MSPs (Managed Service Providers). It streamlines operations such as billing, project management, and service ticketing to improve efficiency and customer service.
Coro integrates with ConnectWise PSA to enable MSPs to report workspace usage data by mapping services (Coro modules and add-ons) and accounts (managed workspaces).
Prerequisites¶
Before you begin this guide, make sure you have:
-
A ConnectWise Manage administration account.
-
Familiarity with the ConnectWise Manage environment.
Configure a ConnectWise PSA connector¶
Note
The processes discussed here are the minimum requirements for configuring ConnectWise.
To integrate Coro with ConnectWise, a PSA connector must be configured. To configure a PSA connector:
Configure ConnectWise¶
Perform the following steps to configure ConnectWise:
Sign into your ConnectWise Manage environment¶
To sign into your ConnectWise Manage environment:
-
Enter the URL provided by ConnectWise, for example,
https://example.connectwise.com
. -
Enter the company, username, and password provided by ConnectWise and then select LOGIN
Provided your login credentials are correct, you successfully log in to your ConnectWise Manage environment:
Create a security role¶
Note
The security role permissions discussed here represent the minimum required to create a ConnectWise connector from the Coro console.
To create a new security role within your ConnectWise Manage environment:
-
Go to System > Security Roles:
-
Select + (New Item) to create a new security role:
-
Enter a Role ID and select Save:
You can now assign permissions to the new security role.
Assign permissions to a security role¶
To assign permissions to an existing security role:
-
Go to System > Security Roles.
-
Select the Role dropdown:
The Select a Role dialog appears:
-
Select an existing security role.
A list of role permission categories appears:
-
Configure the following role permissions:
-
Expand Companies and set Inquire Level to All for Company Maintenance:
-
Expand Finance and set Inquire Level to All for Agreement Sales:
-
Set Add Level, Edit Level, and Inquire Level to All for Agreements:
-
To configure Agreements, select Customize and verify all sections are set to Allow, and then select SAVE:
-
Expand Procurement and set Inquire Level to All for Product Catalog and Products:
-
Expand Service Desk and set Add Level, Edit Level, and Inquire Level to All for Close Service Tickets, Merge Tickets, and Service Tickets:
-
Expand System and set Add Level, and Inquire Level to All for Table Setup:
-
To configure Table Setup, select Customize and verify Company/Company Status, Company/Company Type, Invoicing/Billing Cycle, and Service/Service Board are set to Allow, and then select SAVE:
-
-
Select Save:
A confirmation notification appears:
Create a new API member¶
A ConnectWise API member is a specific type of user account created within the ConnectWise Manage platform designed to interact with the platform's API.
To create a new API member:
-
Go to System > Members:
-
Select the API Members tab:
-
Select + (New Item) to create a new API member:
-
Enter the following API member Profile information:
-
Member ID
-
Member Name
-
Time Zone
-
Email (Optional)
-
-
Select the following API member System information:
-
Role ID: See Creating a security role
-
Level
-
Name
-
Location
-
Business Unit
-
Default Territory
-
-
Use the Notes section to enter additional information related to the API member. Additionally, select the clock option to auto insert a timestamp:
-
Select Save:
A confirmation notification appears:
Retrieve public and private keys¶
After creating an API member and assigning the minimum security roles, you can generate and retrieve the public and private keys.
To generate and retrieve the public and private keys for an API member:
-
Go to System > Members:
-
Select an existing API member:
-
Select the API Keys tab, and then select + (New Item):
-
Enter a relevant Description, and then select Save:
The API member record is updated, and both the public and private keys are generated:
Warning
The private key is available only at the time of creation and is not retrievable later.
Configure the Coro console¶
After configuring ConnectWise, perform the following steps to configure the Coro console:
Create a ConnectWise connector¶
Important
PSA connectors are only configurable within channel workspaces. For further information, see Workspace overview.
To create a ConnectWise PSA connector:
-
Sign into the Coro console and select Control Panel from the toolbar:
-
Under Workspace, select Connectors:
The Connectors page appears:
-
Select the PSA tab:
-
Select ADD CONNECTOR:
If you have existing PSA connections, select + ADD CONNECTOR:
The Add PSA Connection dialog appears.
-
Select Connectwise:
The Add ConnectWise connector dialog appears:
-
Enter the following information:
-
Company name: provided by ConnectWise.
-
ConnectWise domain: Your domain is typically the URL provided by ConnectWise (see Sign in), excluding the https:// prefix. For example, if your ConnectWise URL is
https://api-staging.connectwisedev.com
, the domain isapi-staging.connectwisedev.com
. -
Public key: See Retrieving public and private keys.
-
Private key: See Retrieving public and private keys.
-
-
Select CONNECT:
Provided the credentials are correct, the ConnectWise connector is created, and appears in the PSA Connectors list as Connected.
The Workspace mapping and Service mapping columns appear with a Setup required status.
After the ConnectWise connector is created and listed as Connected in the PSA Connectors list, you can map workspaces and services.
Map workspaces¶
Workspace mapping allows you to link Coro child workspaces to ConnectWise companies. A ConnectWise company represents a Coro child workspace.
Important
Make sure your ConnectWise data is configured correctly to ensure there is a one to one mapping between your Coro workspaces and ConnectWise companies.
To map a ConnectWise company to a Coro workspace:
-
Under Workspace mapping, select Setup required:
The Workspace mapping page appears:
The Coro workspace column displays all Coro child workspaces that are linked to the current channel workspace.
-
From the ConnectWise Company column of the intended workspace record, select the dropdown next to Map:
A list of Connectwise companies appears:
-
Use the search field to find the required ConnectWise company:
-
Select the company from the filtered list:
The Connectwise company is successfully mapped to the Coro child workspace:
The company selected from the ConnectWise company dropdown in the Coro console corresponds to the Company Name in ConnectWise Manage:
Important
Ensure the Connectwise company is mapped to the correct Coro child workspace.
-
Select the PSA tab on the Connectors page:
The Workspace mapping column now shows that one (out of four) Coro child workspaces is mapped to a ConnectWise company:
Note
Perform additional workspace mapping as required.
Map services¶
After mapping your workspaces, proceed to service mapping to associate Coro services with ConnectWise products. A ConnectWise product represents a specific Coro module or add-on, for example, Endpoint Security or Secure Messages.
Important
Make sure your ConnectWise data is configured correctly to ensure there is a one to one mapping between your Coro services and ConnectWise products. Ensure each company has an agreement that contains only one of each Coro product type.
To map a ConnectWise product to an available Coro service:
-
Select the value listed under the Service mapping column:
The Service mapping page appears:
-
From the ConnectWise Services column of the targeted workspace record, select the Map dropdown:
A list of Connectwise products appears:
-
Use the search field to find the required ConnectWise product:
-
Select the product from the filtered list:
The Connectwise product is successfully mapped to the Coro service:
The service selected from the ConnectWise services dropdown in the Coro console corresponds to the product listed on the Product Catalog in ConnectWise Manage:
Important
Ensure the Connectwise product is mapped to the correct Coro service.
-
Select the PSA tab on the Connectors page:
The Service mapping column now shows that one (out of 21) Coro services are mapped to a ConnectWise product:
Note
Perform additional service mapping as required.
After successfully mapping workspaces and services, the integration setup between ConnectWise Manage and Coro is complete. Device and user data across all connected company Coro workspaces is synchronized daily.