NOTE: The instructions below are based on ConnectWise Automate 12. If you're using ConnectWise Automate v11, please follow the Integrating with ConnectWise Automate v11 article.
- Add plugin
- Add Auvik clients and locations
- Set ConnectWise Automate user permissions
- Configure Auvik plugin
- Update the plugin
Add the Auvik ConnectWise Automate plugin
NOTE: Version 1.0.6.0+ of the Auvik plugin is supported with Automate v12.
- Log into the ConnectWise Automate Control Center.
- From the navigation menu, click System, then Solutions.
- Click Solution Center.
- Search for Auvik.
- Hover over the solution and click Queue.
- Agree to the Terms of Service by clicking Yes.
- From the side navigation bar, click Solutions Queue.
- Click Install/Update.
- Click Yes.
- Close Solution Center.
- From the navigation menu, click System, then Solutions.
- Click Plugin Manager.
- From the list of ConnectWise Automate plugins, select the row for the Auvik ConnectWise Automate plugin.
- Click Enable.
- Restart the ConnectWise Automate Control Center console.
Add ConnectWise Automate clients and locations
If your clients are already set up in ConnectWise Automate, you can skip this step and move on to Set ConnectWise Automate permissions.
Add clients
Complete the steps below for each new client that needs to be added.
- Log into ConnectWise Automate Control Center.
- Right-click on Clients, then click Create Client.
- Enter the client name and optionally, other details about the client.
- Click Create.
Add locations
Complete the steps below for each new location that needs to be added.
- Right-click on the new client. From the context menu, select Create Location.
- Enter a display name and optionally, other details about the location.
- Click Create.
Set ConnectWise Automate permissions
When setting permissions, you first need to set the appropriate plugin access level for your existing user classes. Then you set permissions for each of the classes for each user.
Set plugin permissions
Before your ConnectWise Automate users can gain access to your Auvik clients, you have to set plugin permissions on the appropriate user classes.
Follow the steps below to set the plugin permissions on the ConnectWise Automate Super Admin and Help Desk Users user classes. For the ConnectWise Automate Super Admin user class, access to the Auvik plugin is granted for both configuration and client and location access. For the ConnectWise Automate Help Desk Users user class, access to the Auvik plugin is restricted to client and location access only.
We’ll be modifying the existing ConnectWise Automate Super Admin user class and a non-ConnectWise Automate administrator class (help desk users, for example).
- From the navigation menu, click System, then Users and Contacts.
- Click User Class Manager.
- From the list of user classes, highlight the Super Admin class.
- Click the Plugin tab.
- Check Auvik.
- Click Save.
- From the list of user classes, highlight a non-ConnectWise Automate administrator class that has client read permissions (help desk users, for example).
- Click the Plugin tab.
- Check Auvik.
- Click Save.
Repeat steps 5 through 10 for each user class that should have Auvik plugin access.
Set client permissions
Complete the steps below to set the Auvik location permissions for each client.
- Right-click on the new client. From the context menu, select Open.
- Click the Permissions tab.
- Right-click in a blank space in the list of user classes, then select a user class (Help Desk Users, for example) that’s been assigned the Auvik plugin permission.
- Click on the appropriate permission, and for Locations check the Read permission.
- Click Save.
- Close the ConnectWise Automate Control Center.
Configure the Auvik plugin
To configure the Auvik plugin, you need a valid Auvik user and the user’s API key.
NOTE: In this version of the integration, only a single Auvik user can be configured for the ConnectWise Automate plugin. If that Auvik user has read-only permissions in Auvik, every ConnectWise Automate user will have read-only permissions for Auvik through ConnectWise Automate. If the Auvik user has admin permissions, every ConnectWise Automate user will have admin permissions for Auvik through ConnectWise Automate.
Set the API user credentials
- Log into the ConnectWise Automate Control Center.
- From the navigation menu, click System, then Configuration.
- Click Dashboard.
- Click the Config tab.
- Click the Integration tab.
- Click the Auvik tab.
- Enter the email address for the Auvik user.
- Paste the API key previously copied from Auvik for the user.
- Enter the domain for your parent (top-level) Auvik account.
- Click Test Credentials to make sure they’re working properly.
- Click OK.
- Click Save.
- Click OK.
If the test connection fails, see How do I troubleshoot issues with my Auvik / ConnectWise Automate integration? for possible resolutions.
Client mapping
Complete the steps below for all clients and locations to be mapped with an Auvik client.
If you want, you can filter your list of ConnectWise Automate clients to show only a specific client’s associated locations.
The mapping of ConnectWise Automate clients and locations is based on:
- Auvik MSP (multi-client) > ConnectWise Automate client
- Auvik Client > ConnectWise Automate location
If you have multiple MSPs (multi-clients) associated to your main MSP account, be sure to select the appropriate Auvik MSP to be mapped to the ConnectWise Automate client. This ensures the correct list of Auvik clients displays for mapping the locations.
If you don’t see a list of your ConnectWise Automate clients and locations, see How do I troubleshoot issues with my Auvik / ConnectWise Automate integration? for possible resolutions.
- From the list of clients to be mapped, click the pencil for a client.
- From the list of your MSPs, select the appropriate MSP to be mapped. If you don’t see any MSPs listed, confirm the domain entered in the API User Credentials is for your main MSP domain.
- Click Save.
- From the client’s list of locations, click the pencil for a location.
- From the list of Auvik clients, select the appropriate client to be mapped to the location. If you don’t see the correct list of Auvik clients, confirm the MSP mapped to the ConnectWise Automate client is correct.
- Click Save.
Repeat steps 1-6 for each ConnectWise Automate client and location.
Update the Auvik / ConnectWise Automate plugin
Complete the following steps whenever an update to the plugin has been published.
- Log into the ConnectWise Automate Control Center.
- From the navigation menu, click System, then Solutions.
- Click Solution Center.
- Search for Auvik.
- Hover over the solution and click Queue.
- Agree to the Terms of Service by clicking Yes.
- From the side navigation bar, click Solutions Queue.
- Click Install/Update.
- Click Yes.
- Close Solution Center.