Hiding The Refresh Button In BusinessObjects XI R2 Web Intelligence Reports

How To Do It

Hiding the Refresh button in BusinessObjects XI R2 Web Intelligence reports might seem like a troublesome feat at first, particularly because BusinessObjects does not provide a built in option to do it out of the box. It is not and is considerably very simple.

To do it, the editing of a simple JavaScript file is required. This JavaScript file is responsible for loading the default Web Intelligence viewer that is bundled with BusinessObjects XI R2. Special thanks goes out to cgarcesg at Forum Topics for his original idea.

As a quick look ahead, this is what the small modification will accomplish:

1. Examine the URL query string and search for a specific parameter


2. Based on the value of the parameter, taken an action to display or hide the Refresh button

Perform the following steps in order to apply the aforementioned modification:

1. Locate a JavaScript file named viewer.js. This file will be located in the following directory:
   
   [BOInstallDirectory]\Tomcat\webapps\businessobjects\enterprise115\desktoplaunch\viewers\cdz_adv\language\[BOLanguage]\scripts
   
   Where [BOInstallDirectory] is replaced with the BusinessObjects root installation directory and [BOLanguage] is replaced with the installation language of BusinessObjects.


2. Prepend the following function to the top of the file. This function will be responsible for retrieving a query string parameter from the URL:
   
   

   // Retrieve Query String Parameter From URL.
   //
   // Function courtsey of lobo235  at
   // http://www.netlobo.com/url_query_string_javascript.html
   //
   // @param string name
   // @return string
   function gup( name )
   {
       name = name.replace( /[\[]/ , "\\\[" ).replace( /[\]]/ , "\\\]" );
       var regexS = "[\\?&]"+name+"=([^&#]*)";
       var regex = new RegExp( regexS );
       var results = regex.exec( window.location.href );
       if( results == null )
           return "";
       else
           return results[ 1 ];
   }
   



3. Scroll down in the file until you find the following code segment:
   
   

   refreshDocIcon = addIcn(
       "refresh" ,
       7 ,
       ( bFullScreen ? null : "Refresh Data" ) ,
       "Refresh data to return latest results from the database"
   )
   

   
   
   Replace it with the following code segment:
   

   ( ( gup( "hideRefresh" ) == 1 ) ? refreshDocIcon = null : refreshDocIcon = addIcn(
       "refresh" ,
       7 ,
       ( bFullScreen ? null : "Refresh Data" ) ,
       "Refresh data to return latest results from the database"
   ) )
   

How To Use It

To use the modification, simply open a Web Intelligence document using the openDocumentscript that is supplied by Business Objects. Append the following parameter to the URL’s query string in order to hide the Refresh button when the Web Intelligence document loads:

hideRefresh=1

So, for example, if you want to load a Web Intelligence document with an id of 1000 and with the Refresh button hidden, you would do so using the openDocument script in the following format:

http://[BOCMSName]:[BOCMSPort]/businessobjects/enterprise115/desktoplaunch/opendoc/openDocument.jsp?sType=wid&iDocID=1000&hideRefresh=1

Where [BOCMSName] is replaced with the name or the IP address of the BusinessObjects CMS you wish to connect to and [BOCMSPort] is replaced with the port the BusinessObjects CMS you wish to connect to is listening on for incoming connections.

Excluding the hideRefresh=1 parameter from the openDocument script will not make any changes and the Refresh button will remain visible. So feel free to ignore it in cases where you do not want the Refresh button to be hidden.