Data Protection - How to run iConsole Reports in debug mode

Document ID : KB000010949
Last Modified Date : 12/04/2018
Show Technical Document Details
Introduction:

While it is possible to log search requests in the CA Data Protection iConsole, this information is a snapshot of user activity.  (For example, which user ran a search and at what time and how long it took to return the results).  

If there is a problem running a report or search, it may be useful to see what information is being passed from the iConsole to the CMS Database (For example, the SQL query).

 

Environment:
CA Data Protection 14.x/ 15.x
Instructions:

In order to enable the debug functionality for iConsole reports and searches running against a SQL Server follow the steps below:

Pre-requisite.  

Ensure that you have a folder created on C: drive named Temp (i.e. C:\Temp).

 

Step 1

OLE Automation must be enabled on SQL Server. This requires two steps (step 1 and step 2).

Enable OLE Automation (as sa):

-------------------------------------------------------

exec sp_configure 'show advanced options', 1 

reconfigure exec sp_configure 'OLE Automation Procedures', 1 

reconfigure 

-------------------------------------------------------

Step 2

Grant access to OA methods (as sa).

-------------------------------------------------------

use master 

grant execute on [sys].[sp_OACreate] to [public] 

grant execute on [sys].[sp_OAMethod] to [public] 

grant execute on [sys].[sp_OADestroy] to [public] 

grant execute on [sys].[sp_OAGetErrorInfo] to [public] 

-------------------------------------------------------

 

Step 3

Configure the iConsole Search or report with debug.

 

(a) Login to the iConsole as an Administrator and  

(b) Go to the "Administrator" tab ->  

(c) Expand "Standard Search" folder ->

(d) Click on the "Standard Search (2.12)" corresponding  action button

(e) Navigate to "Edit properties" and click on the "Customize" button.

(f) Locate “debug Log ($DEBUG)” from "Available fields" and move to the "Selected fields" and the click OK

(g) Save the Search with a New name (i.e. Standard Search 2.12 Debug).  

 

Note: You may be prompted to assign the Search to a Role.  If you are using a particular Role in relation to the testing assign the search to that role otherwise add the search to [Unmanaged}.

 

(h) Login in to the iConsole as the test user\reviewer and go to the Review Tab.  Locate the saved standard search (see g) and select the corresponding "Action" button.  Now click "Edit Properties" and Click on the Settings Tab.   Click on the check box “Debug Log” to enable debug log. Set any other properties (i.e. date range groups etc.) and When you are ready click on "Run". When the report is Run with the debug option enabled it creates a new log file in the folder C:\Temp.
 

In order to enable the debug functionality for iConsole reports and searches running against an Oracle DB Server follow the steps below:

Pre-requisite.  

Ensure that you have a folder created on C: drive named Temp (i.e. C:\Temp).

Step 1

1. You need to grant the "CREATE ANY DIRECTORY" privilege to the WgnUser account. 
2. Run the batch file present at below location on the CMS machine. 
C:\Program Files (x86)\CA\CA DataMinder\system\std_rptinst\Common\Enable_Logging.bat 

Step 2

Configure the iConsole Search or report with debug.

(a) Login to the iConsole as an Administrator and  

(b) Go to the "Administrator" tab ->  

(c) Expand "Standard Search" folder ->

(d) Click on the "Standard Search (2.12)" corresponding  action button

(e) Navigate to "Edit properties" and click on the "Customize" button.

(f) Locate “debug Log ($DEBUG)” from "Available fields" and move to the "Selected fields" and the click OK

(g) Save the Search with a New name (i.e. Standard Search 2.12 Debug).