KB45785: How to Add a Custom Folder to the Desktop Page Using the MicroStrategy Web SDK 9.3.1-9.4.1

Using the Web Customization Editor to create a plug-in
 
Strategy SDK provides a Web Customization Editor that can be used to create a customization plug-in. The following steps show how to create the plug-in and deploy.

• Create a new plug-in and give it a meaningful name. For example: AddingFolderToDesktopPage. (For step by step instructions on creating a new plug-in, please navigate to Home > Web SDK > Customizing Strategy Web > Web Customization Editor > Features and Customizable)
• Click in 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.
• Navigate to Strategy Web Configuration > Pages 
• Double click on desktop(Desktop)
• Right click on content - Desktop_Content.jsp and select Edit Current File
• Modify the following line from
  
   
  
  

  
  <jsp:include page='jsp/Desktop_View_Compact_Section.jsp' flush="true" />

  
   
  
  
  to
   
  
  

  
  <jsp:include page='/plugins/AddingFolderToDesktopPage/jsp/Desktop_View_Compact_Section.jsp' flush="true" />

  
   
  
  
   
  
• Save the changes.
• Minimize Eclipse.
• Navigate to the Strategy Web directory and make a copy of ..\Strategy\jsp\Desktop_View_Compact_Section.jsp and paste it in the ..Strategy/plugins/AddingFolderToDesktopPage/jsp folder
• Using any text editor, edit the Desktop_View_Compact_Section.jsp file in the ..Strategy/plugins/AddingFolderToDesktopPage/jsp folder
• To have the custom folder as seen above find this node:
  
   
  
  

  
  <web:ifFeature name="public-reports"> <web:then>
  <web:urlEvent eventID="com.Strategy.web.beans.EnumFolderBeanEvents.FOLDER_EVENT_BROWSE" linkAttributes ="class='mstr-dskt-lnk shared'">
  <web:eventArgument name="com.Strategy.web.beans.EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_SYS_FOLDER" value="7" />
  <div class="mstr-dskt-icn"> </div>
  <div class="mstr-dskt-nm">
  <web:descriptor key="mstrWeb.2" desc="Shared Reports" /></div> <div class="mstr-dskt-dsc"><web:descriptor key="mstrWeb.1322" desc="Browse a list of prepared reports available to all users." /></div>
  </web:urlEvent> </web:then></web:ifFeature>

  
  
  
  
  After this node, insert the following custom code (modify the value for folder ID and the Descriptor for the name and description):
  
   
  
  

  
  <web:ifFeature name="public-reports"><web:then> 
  <web:urlEvent eventID="com.Strategy.web.beans.EnumFolderBeanEvents.FOLDER_EVENT_BROWSE" linkAttributes ="class='mstr-dskt-lnk folder'">
  <web:eventArgument name="com.Strategy.web.beans.EnumFolderBeanEvents.FOLDER_EVENT_ARGUMENT_FOLDER_ID" value="4E09598F41540E2AFEF718AF3EA0FF9E" />
  <div class="mstr-dskt-icn"></div> 
  <div class="mstr-dskt-nm">
  <web:descriptor desc="Becca's Folder" /></div> 
  <div class="mstr-dskt-dsc">
  <web:descriptor desc="This is a test." /></div> 
  </web:urlEvent> </web:then></web:ifFeature>

  
   
  
  
   
  
• Save your changes
• Navigate to the Strategy Web directory and make a copy of ..\Strategy\style\mstr\images\iconView.gif and paste it in the ..Strategy/plugins/AddingFolderToDesktopPage/style/mstr/images folder
• Maximize Eclipse or reopen Eclipse
• Click on the CSS Settings view tab.
• Navigate to CSS > Strategy Web Styles > style > mstr
• Right click on mstr.css and click on New Selector, use the following as the selector value:
  
  .mstr-dskt-lnk.folder .mstr-dskt-icn
  
  The Apply Selector to: All Pages radio button should be selected
• Navigate to CSS > Customized Web Styles > style > global.css
• Right click on the .mstr-dskt-lnk.folder .mstr-dskt-icn selector and click Open in Editor.
• Click the Add button to add a new property: background-image
  The following should be its value: url(images/iconView.png) !important
• Click the Add button to add a new property: background-position
  The following should be its value: -60px -85px
• Click OK
• Restart the Web Server. Here is what the Desktop page looks like with the changes above: 

 
 
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://community.strategy.com/topic/0TO44000000FliLGAS/sdk).
 
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/en/support/contact-support.  
 
 
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.