KB37593: How to modify the Preferences Links on the Summary Page to match the Preferences Links on the Desktop Page using MicroStrategy Web SDK

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.

Desktop (Home) Page Preferences Links (default):

 
Summary Page Preferences Links (default):
 

Summary Page Preferences Links (customized):

 
The following example will change the default Preferences Links on the Summary Page to match the default Preferences links on the Desktop (Home) Page.

• Launch the Web Customization Editor.
• Create a new plug-in and give it a meaningful name.  For example: SummaryPreferencesModification.
• 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.
• Click on Pages to expand the list of pages used in Strategy Web.
• Navigate to the summary(Summary) page.
• Expand the Beans node for that page. 
• Right-mouse click the Beans and select New Bean. This launches the New Web Bean wizard that guides you in adding a child bean.
• Fill in the Wizard as follows:
  Name: preferences
  System Bean:  PreferencesBean
  Persist Mode: Request
  
• Click Next.
• No features will be associated with this bean, click Next.
• There will be no custom event handler for this bean, keep the default radio button set to No, click Next.
• For the INITIALIZATION properties, add currentGroupSet from the left pane to the right pane using the >> button, click Next.
• There will be no REQUEST properties, click Next.
• The Results window should appear, click Finish.
• The Bean Properties for the newly created preferences bean should open in the editor.
  
• Set the value for the Initialization Properties “currentGroupSet” to “user”.
   
  

• Click on the Bean Styles tab and click on the Add button to add the DesktopUserPreferences style from the left pane to the right pane using the >> button, click OK.
   
  

• Save your changes.
• Minimize the Web Customization Editor.
• Navigate to the jsp or asp folder of the Strategy Web installation.
   
  
  For JSP:
  
  Copy the Summary_Tools_Section.jsp file.
   
  
  For ASP:
  
   
  
  Copy both the Summary_Tools_Section.ascx and Summary_Tools_Section.ascx.vb files.
  
   
  
• Paste the file(s) in the jsp or asp folder inside the plugins folder of the Strategy Web installation.   For example: plugins/ SummaryPreferencesModification /jsp or plugins/ SummaryPreferencesModification /asp.
• Edit the copied Summary_Tools_Section.jsp or Summary_Tools_Section.ascx file to use the new preferences bean.  Remove the following lines of code:
   
  FOR JSP:
   
  
  Sample Code/Error
  <web:urlEvent eventID="com.Strategy.web.app.beans.EnumServletEvents.WebEventOpenPreferences">
          <web:eventArgument name="com.Strategy.web.app.beans.EnumServletEvents.WebEventArgumentPreferenceGroup" value="general"/>
  …
              <web:urlEvent eventID="com.Strategy.web.app.beans.EnumServletEvents.WebEventNCPrintAddresses">
                  <web:descriptor key="mstrWeb.3147" desc="Printers"  />
              </web:urlEvent>
          </web:then>
       </web:ifFeature>
  
  
   
  and replace it with
   
  
  
  Sample Code/Error
  <web:displayBean bean="preferences" styleName="DesktopUserPreferencesStyle" />
  
  
   
  
  FOR ASP:
  
   
  
   
  
  Sample Code/Error
       <web:urlEvent runat="server" eventID="com.Strategy.web.app.beans.EnumServletEvents.WebEventOpenPreferences">
          <web:eventArgument runat="server" name="com.Strategy.web.app.beans.EnumServletEvents.WebEventArgumentPreferenceGroup" value="general"/>
          <web:descriptor runat="server" key="mstrWeb.295" desc="General"  />
  …
       <web:ifFeature runat="server" name="create-print-location">
          <web:mthen runat="server">
              <web:urlEvent runat="server" eventID="com.Strategy.web.app.beans.EnumServletEvents.WebEventNCPrintAddresses">
                  <web:descriptor runat="server" key="mstrWeb.3147" desc="Printers"  />
              </web:urlEvent>
          </web:mthen>
       </web:ifFeature>
           </td>
          </tr>
         </table>
  
  
   
  and replace it with
   
  
  
  Sample Code/Error
  <web:displayBean runat="server" bean="preferences" styleName="DesktopUserPreferencesStyle" />
  
  
   
  
   
  
• Save your changes.
• Return to the Web Customization Editor.
• Click on Strategy Web Configuration inside the Application Settings view to expand the hierarchical tree.
• Click on Pages to expand the list of pages used in Strategy Web.
• Navigate to the summary(Summary) page.  Double-click to open the summary(Summary) page editor.
• Click on the Template Properties tab.
• Right click on content - /jsp/Summary_Content.jsp or content – Summary_Content.ascx and choose Edit current file.
• When prompted to continue, choose Yes.  This will copy the Summary_Content.jsp or Summary_Content.ascx file to the jsp/asp folder within the custom plug-in.
• Modify the following line:
   
  FOR JSP:
   
  
  Sample Code/Error
  <jsp:include page='/jsp/Summary_Tools_Section.jsp' flush="true" />
  
  to
   
  
   
  
  Sample Code/Error
  <jsp:include page='/plugins/SummaryPreferencesModification/jsp/Summary_Tools_Section.jsp' flush="true" />
   
  
  
   
  FOR ASP:
   
  
   
  
  Sample Code/Error
  <web:include runat="server" flush="false" path="Summary_Tools_Section.ascx" /> 
  
  to
   
  
   
  
  Sample Code/Error
  <web:include runat="server" flush="false" path="../plugins/SummaryPreferencesModification/asp/Summary_Tools_Section.ascx" />
   
  
  
   
  
• Save your changes.
  
• Restart the Web Server.
  
• Launch Strategy Web to view the customization.
  

 
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.