guide to integration implementation · pdf filewebroot global site manager configuration ......

13
1 GUIDE TO INTEGRATION IMPLEMENTATION 4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected] Contents SETUP AND CONFIGURATION ................................................................ 2 Introduction .......................................................................................................................... 2 Requirements ........................................................................................................................ 2 ConnectWise Manage Configuration ...................................................................................... 2 Configuration of a ConnectWise Manage Login ........................................................................................................2 Configuration of ConnectWise Manage to access the REST API ...............................................................................3 Webroot Global Site Manager Configuration ......................................................................... 4 Configuration of a Webroot Super Admin ................................................................................................................4 Configuration of Webroot Client Credentials ............................................................................................................5 CONNECTWISE MANAGE WEBROOT INTEGRATION ........................... 6 Company Creation ................................................................................................................. 6 Account Creation ................................................................................................................... 7 Logging In .............................................................................................................................. 7 Account Setup ....................................................................................................................... 8 Configure ConnectWise ......................................................................................................... 9 Configure Webroot .............................................................................................................. 10 AGREEMENT MAPPING ......................................................................... 10 Add a Mapping .................................................................................................................... 11 Review Existing Mappings ................................................................................................... 12 Run Sync ............................................................................................................................. 12 Review Existing Task............................................................................................................ 13

Upload: phungduong

Post on 23-Mar-2018

215 views

Category:

Documents


3 download

TRANSCRIPT

1

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Contents SETUP AND CONFIGURATION ................................................................ 2

Introduction .......................................................................................................................... 2

Requirements ........................................................................................................................ 2

ConnectWise Manage Configuration ...................................................................................... 2

Configuration of a ConnectWise Manage Login ........................................................................................................ 2

Configuration of ConnectWise Manage to access the REST API ............................................................................... 3

Webroot Global Site Manager Configuration ......................................................................... 4

Configuration of a Webroot Super Admin ................................................................................................................ 4

Configuration of Webroot Client Credentials ............................................................................................................ 5

CONNECTWISE MANAGE WEBROOT INTEGRATION ........................... 6

Company Creation ................................................................................................................. 6

Account Creation ................................................................................................................... 7

Logging In .............................................................................................................................. 7

Account Setup ....................................................................................................................... 8

Configure ConnectWise ......................................................................................................... 9

Configure Webroot .............................................................................................................. 10

AGREEMENT MAPPING ......................................................................... 10

Add a Mapping .................................................................................................................... 11

Review Existing Mappings ................................................................................................... 12

Run Sync ............................................................................................................................. 12

Review Existing Task ............................................................................................................ 13

2

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Setup and Configuration

Introduction The ConnectWise Manage Webroot Integration allows you to streamline your customer invoices from

ConnectWise Manage using Site and Group information from within the Webroot Global Site Manager.

Requirements In order to utilize the ConnectWise Manage Webroot Integration fully you must have the following on your

network.

Your ConnectWise Manage software must be setup with login credentials that have access to the

Agreements Module. See ConnectWise Manage Configuration below.

Your ConnectWise Manage software must be setup with login credentials that have access to the REST

API. See ConnectWise Manage Configuration below.

Internet Access: An internet connection is required.

ConnectWise Manage Configuration Before using the Integration, you must ensure that Manage is configured to allow access to Companies,

Agreements, and Products through the REST API.

Configuration of a ConnectWise Manage Login When you set up the Integration, you will need to provide a Manage member’s login credentials that the Integration will use to read and update Manage Agreements. This member can either be the login of the user who will be running the Integration or a new member built specifically for the Integration.

In order for the Member to be able to work with the accounting information, they must be assigned a security role that allows access to the Agreements Interface. With a default installation, the “Role ID” field must be set to either “Finance ”, ”Executive” or ”Admin”.

If you wish to create your own role rather than use the Manage defaults, you need to ensure that the security role levels setting for the “Agreements” line is set to “All” for all levels, as highlighted below:

If you have installed other integrations, you might have created an “Integrator Login”. Note that Manage

works a bit differently, and as such, does not use an “Integrator Login”. The Login must be a normal Manage

member.

3

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Configuration of ConnectWise Manage to access the REST API In addition to accessing the Manage Agreements module, the Integration also requires credentials to access the

REST API. There are two options for providing credentials to access the REST API: APIKey and

MemberImpersonation

Option 1: APIKey Authentication

To setup APIKey Authentication in Manage, navigate to the “API Keys” tab on the member setup for accessing the

Accounting System. Enter a description and click Save to generate a Public/Private key-pair. You may want to save

the Private Key somewhere as it will not be visible again once you close the API Keys screen.

Option 2: MemberImpersonation Authentication

To setup MemberImpersonation Authentication in Manage, open the Integrator Login setup table by navigating to

System > Setup Tables and searching for “Integrator Login”. Click to create a new Integrator Login. Provide a

Username and Password, select “All records” for Access Level, and click to enable the “Member API”

4

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Webroot Global Site Manager Configuration Before using the Integration, you must ensure that the Webroot Global Site Manager is configured to allow access

to the REST API.

You must have a Webroot Global Site Manager Super Admin account.

You must have a Webroot Global Site Manager API Client Credentials.

Internet Access: An internet connection is required.

Configuration of a Webroot Super Admin To setup a Super Admin in the GSM console, navigate to “Admins” and click the “Add” button. Enter the required

information and click Add.

5

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Configuration of Webroot Client Credentials Navigate to the “Account Settings” tab and the API Access sub-tab. Click the “New” button and enter a Name and

Description. Important – Take note of the Client ID and Client Secret. It is not possible to look up the Client Secret

at a later date and it will be required for API access. After you have noted the Client Secret, click the “I have made

note of the client secret” to close the window.

It is strongly recommended to give each integration that uses the GSM API its own set of client credentials.

Following this practice will result in faster performance and more security.

It is recommended to use a name and Description that will indicate that this credential set is used for this

Integration.

6

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

ConnectWise Manage Webroot Integration The ConnectWise Manage Webroot Integration is a web service that allows you to update Manage Company

Agreements with data from the Webroot GSM console. The Integration provides a user interface to map GSM data

to Manage Agreements.

You can access the Integration’s User Interface at: https://webroot.mobiusworks.com/sign_up

Company Creation If you are first setting up your company within the integration you must register your company with the

integration by selecting “Sign Up” on the “Login Options” Menu on the Integration home page. You will be brought

to the following screen.

Fill in each of the fields. All fields are required.

Company Name.

Primary Time Zone.

Manage company ID. (Used to log in to Manage)

Manage Site. (The Site you navigate to in order to log in to Manage)

Your Name.

Your Email Address. This will be used to create your account.

The User who registers the Company will have an email sent to them to finish setting up their User Account.

7

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Account Creation During the initial setup of your Integration, you will receive an e-mail that contains a unique login link. Once you

receive the email and follow the link you will see the following screen.

Enter your desired Integration account password in the “Password” field. Then confirm the desired password in

the “Retype Password” field.

Logging In You can access the Integration at: https://webroot.mobiusworks.com/login

Following this link will present you with the login page.

8

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Enter your ConnectWise Manage Webroot Integration account email address in the “Email Address” field.

Enter your ConnectWise Manage Webroot Integration account password in the “Password” field.

Account Setup When logging in to the Integration for the first time your home page will show a “Configurations” section of the

user dashboard page. The first required step is to configure your Manage connection. You can click the “Configure

ConnectWise” or “Configure Webroot” links in either the Configuration section on the navigational sidebar.

Your ConnectWise Manage Webroot account password was setup during the Account Creation step. If you

have forgotten your password, you can select the Forgot Password option in the side login menu. This will

bring you to a new page that will require your Integration account email address. Once you have entered your

Integration account email address, press the Reset Password button. Once you have submitted your request

for a password reset, you will receive an email from [email protected], and inside this email will be a

unique link to reset your password.

.

9

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Configure ConnectWise Manage The Manage Configuration page allows the setup of a single Manage connection to your Manage company. It will

require a member login with access to the Agreements module and proper credentials to access the REST API. See

ConnectWise Manage Configuration.

To setup your Manage API connection, fill in the correct information for Site, Company ID, Username, Public Key,

and Private Key (if using APIKey authentication) or Member Name, Integrator Username, and Integrator Password

(if using MemberImpersonation.)

10

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Configure Webroot The Webroot Configuration page allows configuration of one connection to your Webroot GSM Console. See

Webroot Global Site Manager Configuration.

Site and API Scope will populate by default. To setup your Webroot connection, fill in the correct information into

the Client ID, Client Secret, GSM Parent Key, Super Admin, and Admin Password.

Agreement Mapping The Agreement Mapping interface is used to tell the Integration how to calculate Additions on Company

Agreements. It does so by allowing you to map a Site or a Group in the Global Site Manger to a Company

Agreement within Manage.

Navigate to the Mappings interface by following the “Agreement Mappings” link in the navigational sidebar.

11

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Add a Mapping At the top of the page you will see an “Add New Mapping” control.

Select a Manage Company, Agreement for that Company, and a Manage Product. All of these are selected from a

dropdown that is populated from the Manage API.

Then, select a GSM Site (and optionally a Group). The selected Site (or Group) will be mapped to the Addition and

Product selected above. This means that the Agreement within Manage will have an Addition created against it for

the Selected Product and the selected Site (or Group) will be used to update quantities on the Agreement

Addition.

Then select either “Point in Time” or “Fair Use” for your Endpoint Tally Method.

Point in Time If Point in Time is selected, All Endpoints that are active at the time that the synchronization is run will be counted

and applied toward the quantity on the Manage Agreement Addition (subtracting the Less Included value).

Then optionally enter an integer number for “Less Included.” Less Included will directly update the Less Included

field on the Agreement Addition within Manage.

Fair Use If “Lookback Days” is selected, enter an integer number to represent the number of days to look back.

Billing Period will use Webroot Endpoint activity during the Current Manage Agreement billing period to

calculate a quantity for the Agreement Addition.

Lookback Days will look at Webroot Endpoint activity during the past X days to calculate the quantity for

the Agreement Addition (where X is the integer entered in the text field.)

Then optionally enter an integer number for “Less Included.” Less Included will directly update the Less Included

field on the Agreement Addition within Manage.

Note – If you hover the mouse over a field on the Add a Mapping control a tooltip explaining the control will be

displayed.

12

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Review Existing Mappings Below the “Add a Mapping” Controls is a control that shows existing mappings.

Here you can review existing mappings. You can also delete existing mappings. The Group column will be empty if

the optional Group field was left empty when the mapping was created. The Billing Period/Lookback Days column

will show “Billing Period” for mappings that were created using the Billing Period option. The number of lookback

days will be shown for mappings that were created using the Lookback Days option.

Run Sync Clicking the “Run Sync” link in the Navigational Sidebar will update all mapped Agreements in Manage as defined

by their mapping rules.

If you leave the page open, it will refresh as the sync progresses and show the sync status of each individual

mapping.

13

GUIDE TO INTEGRATION IMPLEMENTATION

4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected]

Review Existing Task The “Review Existing Task” page allows you to review Recent Sync Tasks that have already been run. This history

can be used to confirm Sync behavior and troubleshoot.

Click on an Agreement Sync record to see details about that Synchronization such as Status of the Sync, Errors that

may have been encountered, Quantity that was set, and Manage Company Name, Manage Product Name, and

Manage Agreement Name.