How to activate debugging for SmartBar for MS CRM 2013/2015

INTRODUCTION

This article describes how to activate debugging for SmartBar for MS CRM 2013/2015.

Addon: SmartBar for MS CRM 2013/2015

Basically there are two possibilities to enable debugging:

Solution 1) Activating debugging by using the SmartBar Settings (recommended way, only if the SmartBar Settings doesn’t work, use the second solution).

Solution 2) Activating debugging manually via MSCRM-ADDONS.com Settingskeys

…

Solution 1) HOW TO: activate debugging by using the SmartBar Configuration, step-by-step description

Open the Settings of SmartBar for MS CRM 2013. Please note, that only user owning at least one of the selected SecurityRoles listed in the SmartBar Config, are able to see the Settins-Icon. You can find the settings at the end of the SmartBar. (See next screenshot)

Screenshot shows: Settings of the SmartBar Dialog. Highlighted in green. Click to enlarge.

This action will open the SmartBar Settings. There choose the “General Settings”-tab and enable debugging. (See next screenshot)

Screenshot shows where to enable debugging in the SmartBar Settings. Click to enlarge.

If debugging is enabled, hit [Save]. Now debugging is activated. Please scroll down and read detailed information on how to access the log files.

Solution 2) HOW TO: activate debugging manually via the “MSCRM-ADDONS.com Settingskeys” step-by-step description

In CRM navigate to “Settings” (see next screenshot).

Screenshot shows the Settings in CRM. Click to enlarge.

In the Settings choose “MSCRM-ADDONS.com Products” in the Extension area. (See next screenshot)

Screenshot shows the “MSCRM-ADDONS.com Products” in the Extension area. Click to enlarge.

This action will open a list of active MSCRM-ADDONS.com Products. (See next screenshot)

Screenshot shows active MSCRM-ADDONS.com Products in CRM. Click to enlarge.

Next choose SmartBar with a double-click. In the next window search for “debugPlugin” (See next screenshot)

Screenshot shows the SmartBar debugPlugin in CRM. Click to enlarge. 

If a result is found double click on it and set the KeyValue on true. (See next screenshot)

Screenshot shows general information of SmartBar debugPlugin. Click to enlarge.

If no setting with this name is found. You have to create a new Settingskey. To do this, please click on the drop-down-button next to SmartBar in the CRM ribbon and select “MSCRM-ADDONS.COM Settingskey”. (See next screenshot).

Screenshot shows where to find the Settingskeys in the CRM ribbon. Click to enlarge.

In the following window, click on “+ADD NEW MSCRM-ADDONS.com Settingskey”. (See next screenshot).

Screenshot shows where to add a new Settingskey in CRM. Click to enlarge.

Now create a new Settingskey with the following value and save your settings. (See next screenshot).

 
Screenshot shows new MSCRM-ADDONS.com Settingskey. Click to enlarge.

HOW TO: acces the log files, step-by-step description 

The log files will be stored in the “MSCRM-ADDONS.com Debug”-entity. The easiest way to access it, is by using the “Advanced Find”. (See next screenshot).

Screenshot shows “Advanced Find” in CRM. Click to enlarge.

This action will open the “Advanced Find”. There select the “MSCRM-ADDONS.com Debug”-entity and include the following condition “Name” must “Contain” “PTMSmartBar”. This ensures that only SmartBar log files will be retrieved. Then hit “Results”. (See next screenshot).

 
Screenshot shows Advanced Find window in CRM. Click to enlarge.

Next delete all retrieved debug records. Another way is to select the debug file by the “Created On” date. Then reproduce the error and refresh the result list of this Advanced Find. This ensures that you only have the latest and relavant log files. Select all records and hit “Export MSCRM-ADDONS.com Debug”. (See next screenshot)

Screenshot shows where to “Export MSCRM-ADDONS.com Debug” in CRM Advanced Find. Click to enlarge.

The following dialog will open:

Check “Dynamic worksheet” and click on [Next >]. In the following “Edit Columns” dialog select “Add Columns”. (See next screenshot).

Use the “Add Columns” functionality of this dialog and add the “ptm_message”-field to the grid. Hit [OK] to continue. (See next screenshot)

Then the column “Message” has been added to this view. Next hit [Export] to continue. (See next screenshot)

Save the Excel file locally and send it with a short error description and a screenshot to our support address (support@mscrm-addons.com). (See next screenshot).

 
Screenshot shows exported debug logfile. Click to enlarge.

Please do not hesitate to contact us, should you require further information or our assistance.