KB39431: How to Add a Context Menu Option that will Automatically Create a Shortcut to a Pre-Specified Location Using the MicroStrategy Web SDK 9.2.1

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.
 
1. Launch the Web Customization Editor.
2. Click on Strategy Web Configuration inside the Application Settings view to expand the hierarchical tree. The expanded list comprises the different settings that can be modified to perform customizations.
3. Expand the folder for Pages so you can see its children.
4. Expand the page for shared(Shared Reports) so you can see its subfolders.
5. Expand the folder for Beans so you can see the beans associated with the shared page.
6. Right-click the OMD bean and select New Event Handler.
7. Specify an appropriate Source folder, Package, Name, and Event Name.
8. Enter an number for the Event ID (i.e. 80123).  Note that by convention, events on the ObjectManipulationDialogBean should have the form 80xxx.
9. Click Next >, then Finish.
10. Open the event handler that was just created.  It will have the same name as specified in step 7.
11. Insert the following code underneath “//TODO implement your logic here“:

try { 
   
    WebIServerSession isess = ((AppContext)getWebComponent().getBeanContext()).getAppSessionManager().getActiveSession();
    WebObjectSource source= isess.getFactory().getObjectSource();
    WebShortcut shortcut = (WebShortcut) source.getNewObject(EnumDSSXMLObjectTypes.DssXmlTypeShortcut);
    WebObjectInfo target = source.getObject(keys.getValue("objectID"), Integer.parseInt(keys.getValue("objectType")), true);
    shortcut.setTarget(target);
    WebFolder targetFolder = (WebFolder) source.getObject("", EnumDSSXMLObjectTypes.DssXmlTypeFolder, true);
    source.save(shortcut, target.getName(), targetFolder);
   } catch (WebObjectsException e) {
    e.printStackTrace();
   } catch (IllegalArgumentException e) {
    e.printStackTrace();
   }

 
12. Save this file.
13. Inside of the Application Settings view, expand the Context Menus folder.
14. Expand the list of folderContextMenus to show the context menus displayed when clicking on an object inside of folder.
15. Right-click default and select New Shortcut.
16. Enter an appropriate name and select OK.
17. For Descriptor, enter the text you wish to see in the context menu.
18. On the bottom of the pane, switch to the Advanced Properties tab.
19. In the HREF field, enter the following, replacing ##### with the event ID specified in step 8:
?evt=#####&src=mstrWeb.shared.OMD&objectType=@oty@&objectId=@oid@
20. Save the context menu.
21. Restart the Web Server for the changes to take effect.
 
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.