SYMPTOM:
When executing a document, a user may want to add some attributes to the Group By section automatically instead of having to add them manually using Design View. This can be achieved using Strategy Web SDK. To accomplish this, perform the steps below.
ACTION:
Follow these steps to add an attribute to the Group By section of a document when it is executed:
1. In the Web Customization Editor (WCE), create a new plugin.
2. Go to Pages > rwd(Report Writing Documents) > Beans > rwframe > rwb as shown below:
3. Create a new event handler for this bean. This handler will use the existing event 2048001.
4. Implement the logic to add an attribute to the Group By section under the processRequest method. A sample implementation is shown below:
public boolean processRequest(RequestKeys keys) throws WebException {
//Get the rw bean
WebEvent event = getWebEvent(keys);
RWBean rwb = (RWBean) getWebComponent();
RWInstance rwi = null;
RWDefinition def = null;
try {
//Retrieve the RW Definition
rwi = rwb.getRWInstance();
def = rwi.getDefinition();
} catch (WebBeanException e) {
e.printStackTrace();
} catch (WebObjectsException e) {
e.printStackTrace();
}
if(event == null) {
return super.handleDefaultRequest(keys);
}
switch(event.getID()) {
case 2048001 :
//Retrieve the list of group by elements and append a new one by object key
RWGroupBys gList = def.getGroupBys();
System.out.println(gList.size());
gList.add("8D679D3511D3E4981000E787EC6DE8A4", EnumDSSXMLObjectTypes.DssXmlTypeAttribute, "K250", "K6");
return true;
default :
return super.handleDefaultRequest(keys);
}
}
7. Restart the web server.
The example provided in this document is provided “as-is” to the user and assumes that the user:
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:
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 MicroStrategy Developer Hub .
To access the Strategy Developer Hub, 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 Hub, 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.