Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ......

9
1 GUIDE TO INTEGRATION IMPLEMENTATION 4110 George Road, Tampa, FL 33634 | 813-463-4740 | [email protected] Table of Contents About ConnectWise Integration ......................................................................................................................................................... 2 Customer Usage and Other Data Sent to ConnectWise ................................................................................................................. 2 Setting up the Integration ................................................................................................................................................................... 3 Initial Setup in ConnectWise ........................................................................................................................................................... 4 Initial Setup in Sophos Central Partner Console ............................................................................................................................. 5 Sync Sophos Central customers with ConnectWise ........................................................................................................................ 7 What happens in the initial sync ......................................................................................................................................................... 8 What happens in ConnectWise....................................................................................................................................................... 8 What you see in Sophos Central Partner console ........................................................................................................................... 8 Support ............................................................................................................................................................................................... 9 Legal Notices ....................................................................................................................................................................................... 9

Transcript of Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ......

Page 1: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

1

GUIDE TO INTEGRATION IMPLEMENTATION

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

Table of Contents About ConnectWise Integration ......................................................................................................................................................... 2

Customer Usage and Other Data Sent to ConnectWise ................................................................................................................. 2

Setting up the Integration ................................................................................................................................................................... 3

Initial Setup in ConnectWise ........................................................................................................................................................... 4

Initial Setup in Sophos Central Partner Console ............................................................................................................................. 5

Sync Sophos Central customers with ConnectWise ........................................................................................................................ 7

What happens in the initial sync ......................................................................................................................................................... 8

What happens in ConnectWise ....................................................................................................................................................... 8

What you see in Sophos Central Partner console ........................................................................................................................... 8

Support ............................................................................................................................................................................................... 9

Legal Notices ....................................................................................................................................................................................... 9

Page 2: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

2

GUIDE TO INTEGRATION IMPLEMENTATION

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

About ConnectWise Integration You can connect your Sophos Central account to ConnectWise, a Professional Services Automation (PSA) tool, if the following

apply:

You are part of the Sophos Managed Service Provider (MSP) program.

You use the Sophos Central Partner console.

You are a ConnectWise user.

Your Sophos Central customer data (in particular, usage of Sophos products) is then synced with ConnectWise. This eliminates

the need to update the same data in two places manually and makes it easier to bill customers regularly for the products they

use. The license usage data is pulled from the Sophos Central database into ConnectWise at predefined intervals, for example

nightly, using the ConnectWise API.

Customer Usage and Other Data Sent to ConnectWise If you're an MSP partner, Sophos Central Partner allows you to manage security for your customers.

You can manage security for two customer types:

Customers who have purchased termed licenses.

Customers who have chosen a monthly usage-based billing model. These customers could use different numbers of

different licenses at different times.

The customers’ product usage is record in the Sophos Central Partner console. Syncing this data with ConnectWise allows you

to easily bill them for products they used in the past month.

Once the integration is setup, the following data is sent to ConnectWise.

Customer Name

License Name

Usage

You can see usage for your monthly customers on the Dashboard, in the Usage For My Monthly Customers section. (See

screenshot below)

Page 3: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

3

GUIDE TO INTEGRATION IMPLEMENTATION

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

Clicking on the View Details link or any of the license categories in the Usage For My Monthly Customers section takes you to

the Managed Customer Usage page.

The usage data displayed here for each customer is sent to their partner's ConnectWise when the integration is set up.

To see a particular customer’s license details and usage, select the customer in the list and click License Details. The customer

overview page is displayed.

Setting up the Integration Before customer data can be mapped and synced between the Sophos Central Partner console and ConnectWise, you need to

do initial setup tasks.

Page 4: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

4

GUIDE TO INTEGRATION IMPLEMENTATION

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

In ConnectWise:

Make sure that the integrator login account is present in ConnectWise.

Generate API keys for integration: a Public Key and a Private Key.

In the Sophos Central Partner console:

Enter ConnectWise details, including the API keys.

These steps are described in detail in the sections that follow.

Initial Setup in ConnectWise Check that you have the integrator login account in ConnectWise. If the integrator account has been removed or deleted, it will

need to be recreated before proceeding. Refer to ConnectWise Integrator Login Setup Table for more information.

Generate API keys for a ConnectWise integration account, as follows:

Note: For more details, see https://developer.connectwise.com/ConnectWise/Authentication

1. In ConnectWise, open the user account that will be used for integration.

2. If the API Keys tab is not displayed, do as follows:

3. Click the tab with the configuration icon

4. In the Tab View Configuration dialog, move API Keys to the Visible Tabs list. Click Save & Close

5. In the API Keys tab, click the New Item icon.

6. In the Description field, enter a description for the new key (e.g. Sophos Central Integration)

Page 5: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

5

GUIDE TO INTEGRATION IMPLEMENTATION

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

7. Save the new item

8. Two API keys are generated and displayed: a Public Key and a Private Key. The Private Key is only displayed at the time

the key is created. Make a note of both keys, as you will need them in order to sync Sophos Central customers with

ConnectWise.

Important: Make a note of both keys or copy them to the clipboard as there is no way to recover the Private Key once the

tab is closed.

Initial Setup in Sophos Central Partner Console To setup the integration with ConnectWise:

To set up integration with ConnectWise:

1. On the Administration menu, click PSA Integration.

Page 6: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

6

GUIDE TO INTEGRATION IMPLEMENTATION

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

2. On the PSA Integration page, next to the ConnectWise logo, click Get Started.

3. Enter the ConnectWise and integration details: ConnectWise Site (URL), ConnectWise Company ID, and API Keys. Click

Save.

Note: If the data you entered is invalid, an error message is displayed. Enter the correct data and click Save again.

Page 7: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

7

GUIDE TO INTEGRATION IMPLEMENTATION

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

The PSA Integration page now displays the details of your ConnectWise settings and the list of customers. Sophos Central

retrieves all agreements that you have set up in ConnectWise. Each of those existing agreements links a company to an

agreement type.

Note: If you need to view or change your ConnectWise settings in future, click Edit Details under Details in the upper left of the

page.

Sync Sophos Central customers with ConnectWise By default, when you first set up integration with ConnectWise, customers are not synced (or are “ignored”).

To sync customer usage and other data with ConnectWise:

1. On the PSA Integration page, find the customer you want to sync. 2. Enter the customer's ConnectWise Customer Name. 3. Select the customer’s Agreement. 4. Under Sync to PSA, enable synchronization.

1. Repeat for each customer you want to sync. 2. Click Save.

Synchronization does not happen immediately. A message is displayed to tell you when synchronizations will happen.

Page 8: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

8

GUIDE TO INTEGRATION IMPLEMENTATION

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

What happens in the initial sync When the initial synchronization happens, you'll see changes in ConnectWise and in Sophos Central.

What happens in ConnectWise

Synchronization does as follows:

1. Creates a Product Catalog in ConnectWise for each Sophos Central product.

2. Creates an Agreement Addition and attaches each Product Catalog to that.

You should enter billing information in ConnectWise for your customers, so that they can be billed for their product usage.

For more details, see the ConnectWise documentation.

What you see in Sophos Central Partner console For customers that are synced, the page now displays synchronization status, their ConnectWise customer ID and agreement

type.

Note: If a synchronization error occurs, click on the error icon in the Sync Status column to see the error details and solution

advice.

Page 9: Table of Contents - ConnectWise Marketplace · PDF fileTable of Contents About ConnectWise ... Your Sophos Central customer data (in particular, usage of Sophos products) is then synced

9

GUIDE TO INTEGRATION IMPLEMENTATION

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

Support For help with

ConnectWise

integration, send an

email to

[email protected].

For general help with the Sophos Central Partner console, you can also:

Open a Support case by sending an email to [email protected].

Visit the Sophos support knowledgebase at www.sophos.com/en-us/support.aspx.

Legal Notices Copyright © 2016 Sophos Limited. All rights reserved. No part of this publication may be reproduced, stored in a retrieval

system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you

are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise

have the prior permission in writing of the copyright owner.

Sophos, Sophos Anti-Virus and SafeGuard are registered trademarks of Sophos Limited, Sophos Group and Utimaco Safeware

AG, as applicable. All other product and company names mentioned are trademarks or registered trademarks of their respective

owners.