KB40210: How to Output Information in a Custom Add-on using the MicroStrategy Web SDK 9.x

 This information is helpful when specifying conditions for when the custom add-on logic should be called. Since Add-ons are called everytime the page loads (like when wait page is hit) or when a manipulation is done on the report, it is important that any custom add-on logic gets called only when needed. 
 
The below sample will show users how to collect and output the following information about a Strategy Report being executed in an Add-on.

1. Project Name
2. Cookies being used
3. Groups current user is a member of
4. Custom parameter added to the URL 
5. Check the event currently processing
6. The execution status of the report

 
public void postCollectData(PageComponent page){
WebUserGroup[] gpArry = null;
RequestKeys keys = page.getAppContext().getRequestKeys();
String usr = page.getAppContext().getAppSessionManager().getUserName();
WebIServerSession sesh = page.getAppContext().getAppSessionManager().getActiveSession();
 
// 1. Collect Project Name
String pName = page.getAppContext().getAppSessionManager().getActiveSession().getProjectName();
WebObjectSource oSource = page.getAppContext().getAppSessionManager().getActiveSession().getFactory().getObjectSource();
//Collect the ReportBean from the current page
ReportBean rb= (ReportBean) page.getRoot().searchChild("rb");
 
 
// 2. Collect the cookies from the current page
ContainerStringCollection cookies = page.getAppContext().getContainerServices().getCookieStrings();
WebObjectInfo wOI;
try {
wOI = sesh.getUserInfo(true);
 
 
// 3. Access the groups which the current user is a member of
gpArry = ((WebUserEntity) wOI).getAncestorGroups();
} catch (WebObjectsException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
for(int i = 0; i<gpArry.length; i++){
//Output array of groups
System.out.println("Group"+i +" :"+gpArry.getDisplayName());
}
System.out.println("Project name is :" +pName);
//Output event currently being executed
System.out.println("Event is:" + keys.getValue("evt"));
 
 
// 4. Output custom tag parameter added to URL
System.out.println("Custom value is:" + keys.getValue("CustomTagName"));
try {
//Output ReportID
System.out.println("Report ID is:" + rb.getObjectName());
 
//5. Check the event currently processing
 RequestKeys keys = getRequestKeys(page);
String evt = keys.getValue("evt");
//check if evt equals "4001" so the logic will only be called when report is executed and not //when a report manipulation is being processed
 
//6. The execution status of the report
//call collectData to make sure the bean has the most recent information
rb.collectData();
int status = rb.getXMLStatus();
//check for EnumRequestStatus.WebBeanRequestSuccessful to perform an action after the //report has run
//use EnumRequestStatus.WebBeanRequestWaitingForUserInput for prompt answering 
 
} catch (WebBeanException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
System.out.println("The status of rb is :" + rb.getXMLStatus());
for(int i=0; i<cookies.getNameCount(); i++){
//Output cookies
System.out.println("Cookies: " +cookies.getName(i));
}
}
 
 
 
The example provided in this document is provided “as-is” to the user and assumes that the user:

• Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
• Can configure environment variables (e.g. JAR files, property files, etc.)
• Have all the necessary tools to create Java applications (JDK, IDE, etc.)
• Has access to the Strategy SDK documentation.
• Has read the customization warning at the bottom of this document

 
PREREQUISITES:
 
For the sample to work, the Strategy Web JAR files must be accessible by the Java Runtime
Environment. The Strategy Web JAR files can be found under:

• Strategy Web Universal (JSP): {web_root}/WEB-INF/lib directory.
• Strategy Web (.NET): Program Files\Common Files\Strategy directory.

Note:
 
More elaborate programs will require additional library files and are out of the scope of this document.
 
 
ADDITIONAL INFORMATION:
 
The Strategy SDK allows you to customize the standard Strategy Web interface, and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy Web products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy Web architecture or the process of customizing Strategy Web, please refer to Strategy Developer Zone (https://resource.microstrategy.com/msdz/).
 
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 http://www.microstrategy.com/Support/ContactUs.asp.
 
 
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.