Microstrategy SDK - Folder Browsing Page

microstrategy-sdk

SaveAsReportTransform
SecurityRoleFolderListStyle
AdminFolderViewTransform
saveasbean_display
SaveReport
saveasbean_pane
folderList
fileList
saveAs

What does MSTR mean by Folder Browsing Page?

When reports, documents, and HTML documents are displayed on the Folder Browsing page, links are available by default for Edit, Subscriptions, Send Now, Export, and PDF. These links are available in both folder browsing modes—List View and Large Icon View. Examples of folder browsing pages: Shared Reports and My Reports.

What are the overall steps for customizing the Folder Browser Page?

  1. Creating a custom layout definition file that does not display the Export and PDF links
  2. Creating a custom Style Catalog Configuration file that uses the custom layout definition file for the Folder Browsing page
  3. Creating a custom page-section file that displays the content of the Folder Browsing page
  4. Creating a custom Page Configuration file that uses the custom page-section file to display the content of the Folder Browsing page
  5. Modifying web.xml to point to the custom Style Catalog Configuration file and the custom Page Configuration file

How can we remove links on the folder browsing page?

In this customization scenario, you remove the Export and PDF links— for both the List View and Icon View folder browsing modes— when the MicroStrategy Tutorial project is accessed. If any other project is accessed, all of the default links are displayed. See file:///C:/Program%20Files%20%28x86%29/MicroStrategy/SDK/docs/mergedProjects/WebSDK/topics/scenarios/Removing_the_Links_on_the_Folder_Browsing_Page_for_Individual_Projects.htm

  1. Launch the Web Customization Editor.
  2. Click on MicroStrategy 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. Click on Styles to expand the list of styles used in MicroStrategy Web.
  4. Right-mouse click FolderStyleList and select Duplicate. This creates a duplicate style called CopyOfFolderStyleList that opens in the Style Properties editor in the right frame.
  5. Right-mouse click CopyOfFolderStyleList and select Rename.
  6. Enter CustomFolderStyleList in the text field and click OK
  7. Click Edit Layout in the Style Properties editor (under Style Layouts tab) to edit the layout definition file, FolderListLayout.xml.
  8. Click Yes in the prompt. FolderListLayout.xml opens for editing.
  9. Remove the Export and PDF links by deleting the code shown in bold below.
<mstrlayout:if name="isActionsTabAvailable">
   <mstrlayout:then>
      <td style="whitespace:nowrap">
         <mstrlayout:slot name="actionButtons">
         <mstrlayout:render name="PDFExport">
            <mstrlayout:argument list="FolderObjects" type="com.microstrategy.web.objects.WebObjectInfo"/>
            <mstrlayout:argument type="boolean" value="false"/>
         </mstrlayout:render>
         <mstrlayout:render name="Export">
            <mstrlayout:argument list="FolderObjects" type="com.microstrategy.web.objects.WebObjectInfo"/>
            <mstrlayout:argument type="boolean" value="false"/>
         </mstrlayout:render>
         ...
         ...
...
...
  1. Save your changes.
  2. Navigate back to MicroStrategy Web Configuration->Styles.
  3. Right-mouse click FolderStyleIcon and select Duplicate. This creates a duplicate style called CopyOfFolderStyleIcon that opens in the Style Properties editor in the right frame.
  4. Right-mouse click CopyOfFolderStyleIcon and select Rename.
  5. Enter CustomFolderStyleIcon in the text field and click OK.
  6. Click Edit Layout in the Style Properties editor (under Style Layouts tab) to edit the layout definition file, FolderIconLayout.xml.
  7. Click Yes in the prompt. FolderIconLayout.xml opens for editing.
  8. Remove the Export and PDF links by deleting the code shown in bold below. Since the Icon View is structured in two columns, there are two instances of the nodes for Export and PDF links. Delete both of them.
</mstrlayout:else>
    </mstrlayout:if>
        <mstrlayout:render name="SendNowInfo">
            <mstrlayout:argument list="FolderObjects" type="com.microstrategy.web.objects.WebObjectInfo"/>
            <mstrlayout:argument type="boolean" value="true"/>
        </mstrlayout:render>
        <mstrlayout:render name="Export">
            <mstrlayout:argument list="FolderObjects" type="com.microstrategy.web.objects.WebObjectInfo"/>
            <mstrlayout:argument type="boolean" value="true"/>
        </mstrlayout:render>
        <mstrlayout:render name="PDFExport">
            <mstrlayout:argument list="FolderObjects" type="com.microstrategy.web.objects.WebObjectInfo"/>
            <mstrlayout:argument type="boolean" value="true"/>
        </mstrlayout:render>
        </mstrlayout:slot>
...
...
  1. Save your changes.
  2. Navigate to Pages->shared (Shared Reports).
  3. Double-click shared (Shared Reports) to launch the Basic Properties editor in the right frame.
  4. Click Template Properties tab at the bottom.
  5. Right-mouse click the content page section and select Edit current file.
  6. Click the Yes button in the prompt to edit Folder_Content.jsp/ascx.
  7. For JSP, replace <web:displayGuiComponent name="folder_browser"/> with the following code:
<web:ifConnectionValue property="projectName" value="MicroStrategy Tutorial">
   <web:then>
       <web:ifFeature name="folderViewMode" type="preference" value="FolderStyleList">
           <web:then>
         <web:displayGuiComponent name="List_folder_browser"/>
           </web:then>
           <web:else>
         <web:displayGuiComponent name="Icon_folder_browser"/>
           </web:else>
       </web:ifFeature>
   </web:then>
   <web:else>
     <web:displayGuiComponent name="folder_browser"/>
   </web:else>
</web:ifConnectionValue>
  1. Save your changes.
  2. Click New in the Display Components section of the Template Properties editor.
  3. Enter List_folder_browser in the text field for Component Name.
  4. Select fb from the drop-down menu for Web bean associated with this component.
  5. Click Next.
  6. Enter CustomFolderStyleList in the text field for Style associated to this component.
  7. Click Next.
  8. Click Finish.
  9. Save your changes.
  10. Click New in the Display Components section of the Template Properties editor.
  11. Enter Icon_folder_browser in the text field for Component Name.
  12. Select fb from the drop-down menu for Web bean associated with this component.
  13. Click Next.
  14. Enter CustomFolderStyleIcon in the text field for Style associated to this component.
  15. Click Next.
  16. Click Finish.
  17. Save your changes.
  18. Navigate to Pages->my (My Reports).
  19. Double-click my (My Reports) to launch the Basic Properties editor in the right frame.
  20. Click Template Properties tab at the bottom.
  21. Right-mouse click the content page section and select Choose a new file.
  22. Navigate to Folder_Content.jsp/ascx inside the customization plug-in folder (example: plugins/pluginName/jsp or plugins/pluginName/asp) and click Open.
  23. Save your changes.
  24. Click New in the Display Components section of the Template Properties editor.
  25. Enter List_folder_browser in the text field for Component Name.
  26. Select fb from the drop-down menu for Web bean associated with this component.
  27. Click Next.
  28. Enter CustomFolderStyleList in the text field for Style associated to this component.
  29. Click Next.
  30. Click Finish.
  31. Save your changes.
  32. Click New in the Display Components section of the Template Properties editor.
  33. Enter Icon_folder_browser in the text field for Component Name.
  34. Select fb from the drop-down menu for Web bean associated with this component.
  35. Click Next.
  36. Enter CustomFolderStyleIcon in the text field for Style associated to this component.
  37. Click Next.
  38. Click Finish.
  39. Save your changes.
  40. Launch MicroStrategy Web to view the customization.
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License