KB20167: How to programmatically set a value prompt with User ID through MicroStrategy Java Web SDK 9.4.1

It is possible to programmatically set a value prompt with User ID by using the following logic in an Add-On:
 
NOTE: the code below assumes that there is only one value prompt in the report. Please modify the code accordingly to fit your environment.
 

public void preCollectData(PageComponent page) {

 ReportBean rb;

 // This method is defined below

 rb = getReportBean(page);
 // Exit the add-on if no report has been defined yet.
 if (rb == null) return;

 try

 { // get user name
  String userName = page.getAppContext().getAppSessionManager().getUserName();

  // ****** NOTE: the following logic assumes that there is only one value prompt.

  WebPrompts prompts = rb.getReportInstance().getPrompts();
  rb.collectData();
  int index = 0;
  int promptType = 0;

  WebPrompt prompt = prompts.get(index);
  if (prompt == null) return;
  else {
   if (!prompt.isClosed()) {
    promptType = prompt.getPromptType();
    if (promptType == EnumWebPromptType.WebPromptTypeConstant) {
     WebConstantPrompt wcp = (WebConstantPrompt) prompt;
     wcp.setAnswer(userName);
     wcp.validate();
    }
   }
  }

  prompts.validate();
  prompts.answerPrompts();
 } catch (WebBeanException ex) {
  throw new WebAppRuntimeException(ex);
 } catch (WebObjectsException ex) {
  throw new WebAppRuntimeException(ex);
 }
}


private static ReportBean getReportBean(WebComponent wc) {
 ReportBean result = null;
 //if the current Web component is a ReportBean then return it
 if (wc instanceof ReportBean) {
  result = (ReportBean) wc;

  //otherwise, try to find a report bean amongst the children
 } else {
  for (int i = 0; i < wc.getChildCount(); i++) {
   //search recursively through all children
   result = getReportBean(wc.getChild(i));
   if (result != null) break;
  }
 }
 return result;
}

 

The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.microstrategy.com).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.microstrategy.com/us/services/support/contact.
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.
 
20167