KB42576: How to add a Cancel Button to the Prompt Page from Design Mode in MicroStrategy Web SDK 10

SYMPTOM:
 
When a prompted report is run from the folder browsing page, a "Cancel" button will be displayed the "Run Report" button as shown below:

However, users will only see an option to run report and not cancel when clicking on the Run Report Toolbar button from a report in design mode as shown below in Strategy Web 10:
 

 
 
CAUSE:
 
This current behavior is expected by design. An enhancement request has been logged requesting the Cancel button to appear by default.
 
ACTION:
 
Contact Strategy Technical Support for an update on this issue.
 
WORKAROUND:
 
Using the Strategy Web SDK, it is possible to work around this issue by programmatically adding a Cancel button and including some custom logic to handle where the cancel will redirect users upon clicking. 
  
There is 2 parts needed to implement this:
Part 1: Modify Prompt to display cancel button when coming from design mode
Part 2:  Capture the cancel redirect event to make user to go parent folder of the report they were viewing in design mode.
 
Part 1:

1. In the WCE, modify the PromptsContainerStyle_Widget:
2. Switch to Layout tab and click Edit Layout:
3. Modify layout:
   search for <mstrlayout:bSetProperty path="cancelButton/visible" method="canCancelPrompt"/>
   Change to:
   <mstrlayout:bSetProperty path="cancelButton/visible" value="true"/>
   
4. Save the changes to the layout file and prompt style.

 
Part 2:

• In the WCE, expand Pages > report (Report Execution) > Beans > frame > rb
• Right-click on rb and select "New Event Handler"
• Create new custom event handler, specifying the following options:

• Add the event handling logic to your class as shown below:

public boolean processRequest(RequestKeys keys) throws WebException {

        WebEvent event = getWebEvent(keys);
        if(event == null) {
            return super.handleDefaultRequest(keys);
        }

        switch(event.getID()) {
            case 4042 :
                ReportBean rb = (ReportBean) getWebComponent();
                AppContext appCtxt = (AppContext) rb.getRoot().getBeanContext();              
                BrowserSettings browsersettings = appCtxt.getBrowserSettings();           
                             
                //first check if this is coming from design mode            
                String lastPageCheck = browsersettings.getHttpSessionValue(EnumWebBrowserSettings.WebBrowserSettingLastPageName);
                if(lastPageCheck.equalsIgnoreCase("report")){
                   System.out.println("design mode clicked cancel!!");

                   //Get the name and state of the last successful page before design mode was clicked

                   String dm = browsersettings.getHttpSessionValue(EnumWebBrowserSettings.WebBrowserSettingLastPageNameDesignMode);
                   System.out.println("dm: " + dm);
                 
                   String dms = browsersettings.getHttpSessionValue(EnumWebBrowserSettings.WebBrowserSettingLastPageStateDesignMode);
                   System.out.println("dms: " + dms);
                   //Set the dm and dms values as the last page and last page state values
                   browsersettings.setHttpSessionValue(EnumWebBrowserSettings.WebBrowserSettingLastPageName, dm); 
                   browsersettings.setHttpSessionValue(EnumWebBrowserSettings.WebBrowserSettingLastPageState, dms);
                }
                return rb.cancelRequest();
            default :
                return super.handleDefaultRequest(keys);
        }