How to collect API logs in ConnectWise 2.0

Topic

This article explains how to gather and send API logs from ConnectWise to Datto Technical Support for troubleshooting ConnectWise Integrations.

Environment

  • ConnectWise 2.0

Description

To gather and send API logs, use the ConnectWise stand-alone client to follow the steps below.

  1. Go to System on the left-hand-side and click Members.


Figure 1: The ConnectWise Manage Admin menu

  1. Click the API Members tab.


Figure 2: API Members

  1. In the API Members tab, select the member ID for the ConnectWise 2.0 integration.


Figure 3: Member IDs

  1. Click start_debug_mode. Debug mode records all actions by that integrator for the time you specify. Do any testing required in this amount of time, i.e., sending test tickets, adding devices, etc.


Figure 4: Debug mode selection

  1. Enter the number of minutes for debug mode to run, then click OK.


Figure 5: Start debug mode

  1. Click Search to generate a list of available logs.

search.png
Figure 6: Search

  1. Click Download Logs and attach them to the ticket for further review.

download.png
Figure 7: Download logs

If the debug mode spots an error, there will be a 'yes' in the right-hand column noting the error and its cause. This note could help you resolve the issue before sending the logs back to Datto Technical Support.

Formatting and reading the logs

Logs downloaded from ConnectWise are challenging to read, You can reformat them to improve readability.


Figure 8: Raw log text, unencoded from SOAP

Follow the steps below to decode and format the log text into a more readable XML format:

  1. Open the logs in a text editor, such as Atom or Notepad++.
  2. Use the Find and Replace feature to replace { and } characters with < and >.
  3. Go to the XML Entities Encoder/Decoder (external link).
  4. Copy and paste the log text into the XML Encoder/Decoder and click decode text.
  5. Paste the decoded log text into the XML Toolbox (external link) and click Format XML.
  6. Paste the formatted text back into your text editor. The logs are now in a more easily readable form.


Figure 9: Formatted ConnectWise logs

Formatting with Atom and Pretty JSON

As an alternative, download the Atom text editor (external link) and install the Pretty JSON (external link).