MicroStrategy ONE

Customizing Debugging Information

Abstractapptransform’s renderDebugInformation() method checks the debugFlags parameter’s value and decides whether to create or not to create any debugging output. Internally three other methods are invoked:

  • renderBeanDebugInformation()  

  • renderTransformDebugInformation()  

  • renderApplicationDebugInformation()

Each of these methods writes the corresponding XML output. The transform writer can overwrite any of these methods to include or remove the desired corresponding information.

Controlling the debug information

The debugFlagsMask parameter allows System Administrators to specify whether certain debugFlag parameters should be available to users.  In order to display certain information, both the debugFlagsMask and the debugFlags must have the flag on. The default value is 0xffff. The debugFlagsMask can be set to any value available in the EnumWebAppDebugFlags enumeration.

An administrator can set a certain value of the debugFlagsMask value in the web.xml and this always take precedence over the  debugFlags or the debugErrorFlags values requested by developers. In cases where the values differ from the set debugFlagsMask value, the information returned to the user is the maximum allowed in the debugFlagsMask value.

The debugFlagsMask parameter is not available by default, but you can add it manually to the web.xml file, so that it filters which values the debugFlags or the debugErrorFlags may have. To set the value, locate the web.xml file in WEB-INF  folder, and add the following <init-param> element to the mstrWeb servlet element. This servlet is identified by <servlet-name>mstrWeb</servlet-name>.

<servlet>

    <servlet-name>mstrWeb</servlet-name>

    <display-name>Main Servlet</display-name>

    <servlet-class>com.microstrategy.web.servlets.MainServlet</servlet-class>

    <init-param>

      <param-name>debugFlagsMask</param-name>

      <param-value>0xffff</param-value>

    </init-param>

     …

</servlet>