Displaying Different Subscription Types on Separate Pages

One of the default links in the menu on the left is a shortcut to the My Subscriptions page. By default, the My Subscriptions page displays a list of subscriptions (History List and Mobile subscriptions) as well as MicroStrategy Distribution Services deliveries (E-mail, File and Print subscriptions).

In this customization scenario, you modify the My Subscriptions page so that only the list of History List and Mobile subscriptions is displayed on the page. You also add a new shortcut to the menu called My Deliveries and create a new My Deliveries page. Clicking the new My Deliveries link opens up the new My Deliveries page, which displays only a list of MicroStrategy Distribution Services deliveries (E-mail, File and Print subscriptions).

Before customization:  My Subscriptions page

After customization:  My Subscriptions page

After customization:  My Deliveries page

This customization can be accomplished using either of the following methods:

• Deploying the plug-in provided with MicroStrategy SDK 

• Using the Web Customization Editor to create a plug-in

Deploying the plug-in provided with MicroStrategy SDK

MicroStrategy SDK provides a plug-in (ZIP file) that can simply be extracted to thepluginsfolder to view the customization in MicroStrategy Web. The following steps guide you in locating the plug-in and deploying it. 

1. Access the plug-in: JSP version or ASP .NET version. 

2. Extract the plug-in to the plugins subfolder inside the MicroStrategy Web installation folder.   

3. Launch MicroStrategy Web to view the customization.

Using the Web Customization Editor to create a plug-in

MicroStrategy SDK provides a Web Customization Editor that can be used to create a customization plug-in. The following steps guide you in creating the plug-in and deploying it. 

1. Launch the Web Customization Editor. 

2. Create a new plug-in and give it a meaningful name. For example: DisplayingSubsSchedsSepPages

3. Exit the Web Customization Editor. 

4. Navigate to the WEB-INF/xml/layouts subfolder inside the MicroStrategy Web installation folder and copy the layout definition file, SubscriptionsLayout.xml. 

5. Paste this copy of layout definition file, SubscriptionsLayout.xml, inside your customization plug-in folder (example: plugins\DisplayingSubsSchedsSepPages\WEB-INF\xml\layouts) and rename it as DeliveriesLayout.xml. 

6. If the Web Customization Editor is closed, launch it again and access your plug-in. 

7. 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. 

8. Click on Styles to expand the list of styles used in MicroStrategy Web. 

9. Right-click NCSubscriptionsListStyle and select Duplicate. This creates a duplicate style called CopyOfNCSubscriptionsListStyle that opens in the Style Properties editor in the right frame. 

10. Right-click CopyOfNCSubscriptionsListStyle and select Rename. 

11. Enter DSDeliveriesListStyle in the text field and click OK. 

12. Click Style Layouts at the bottom in the right frame.

13. Click ... and navigate to the custom layout definition file, DeliveriesLayout.xml in the plugins\DisplayingSubsSchedsSepPages\WEB-INF\xml\layouts subfolder inside the MicroStrategy Web installation folder. 

14. Click Open. The path to the custom layout definition file gets filled in the Layout Definition text field. 

15. Save your changes. 

16. Refresh the Application Settings view by clicking the Refresh View icon, . 

17. 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. 

18. Click on Styles to expand the list of styles used in MicroStrategy Web. 

19. Double-click DSDeliveriesListStyle to open the Style Properties editor in the right frame. 

20. Click Edit Layout in the Style Properties editor (under Style Layouts tab) to edit the new layout definition file, DeliveriesLayout.xml. 

21. Remove the following entire <mstrlayout:if name="isFeatureAvailable"> block of code for History List Subscriptions and Mobile Subscriptions.:

    <mstrlayout:if name="isFeatureAvailable">

       <mstrlayout:argument value="scheduling"/>

       <mstrlayout:then>

         <div class="mstrTitle">

          <mstrlayout:render name="descriptor">

           <mstrlayout:argument type="String" value="mstrWeb.5001"/> <!-- History List Subscriptions -->

          </mstrlayout:render>

          <span class="mstrIcon-inline">

           <mstrlayout:render name="userHelpAnchor">

             <mstrlayout:argument type="String" value="History_List_on_schedule.htm"/>

           </mstrlayout:render>

          </span>

         </div>

       <mstrlayout:render name="subscriptionsByDeliveryMode">

           <mstrlayout:argument type="int" value="16"/>

       </mstrlayout:render>

       </mstrlayout:then>

    </mstrlayout:if>

      

    <mstrlayout:if name="isFeatureAvailable">

       <mstrlayout:argument value="use-mobile"/>

       <mstrlayout:then>

          <div class="mstrTitle">

           <mstrlayout:render name="descriptor">

            <mstrlayout:argument type="String" value="mstrWeb.5002"/> <!-- Mobile Subscriptions -->

           </mstrlayout:render>

           <span class="mstrIcon-inline">

            <mstrlayout:render name="userHelpAnchor">

             <mstrlayout:argument type="String" value="Delivering_reports.htm"/>

            </mstrlayout:render>

           </span>

          </div>

       <mstrlayout:render name="subscriptionsByDeliveryMode">

            <mstrlayout:argument type="int" value="128"/>

       </mstrlayout:render>

       </mstrlayout:then>                        

    </mstrlayout:if>

22. Save your changes. 

23. Navigate back to MicroStrategy Web Configuration->Styles. 

24. Double-click NCSubscriptionsListStyle to open it in the Style Properties editor. 

25. Click Style Layouts at the bottom. 

26. Click Edit Layout in the Style Properties editor (under Style Layouts tab) to edit the layout definition file, SubscriptionsLayout.xml. 

27. Click Yes in the prompt. SubscriptionsLayout.xml opens for editing. 

28. Remove the following entire code for E-mail Subscriptions, File Subscriptions and Print Subscriptions.:

      <div class="mstrTitle">

       <mstrlayout:render name="descriptor">

         <mstrlayout:argument type="String" value="mstrWeb.5003"/> <!-- E-mail Subscriptions -->

       </mstrlayout:render>

       <span class="mstrIcon-inline">

         <mstrlayout:render name="userHelpAnchor">

           <mstrlayout:argument type="String" value="Email_on_schedule.htm"/>

         </mstrlayout:render>

       </span>

      </div>

     <mstrlayout:render name="subscriptionsByDeliveryMode">

       <mstrlayout:argument type="int" value="1"/>

     </mstrlayout:render>

     

      <div class="mstrTitle">

       <mstrlayout:render name="descriptor">

         <mstrlayout:argument type="String" value="mstrWeb.5004"/> <!-- File Subscriptions -->

       </mstrlayout:render>

       <span class="mstrIcon-inline">

        <mstrlayout:render name="userHelpAnchor">

          <mstrlayout:argument type="String" value="Export_on_schedule.htm"/>

        </mstrlayout:render>

       </span>

      </div>

     <mstrlayout:render name="subscriptionsByDeliveryMode">

       <mstrlayout:argument type="int" value="2"/>

     </mstrlayout:render>

     

      <div class="mstrTitle">

       <mstrlayout:render name="descriptor">

         <mstrlayout:argument type="String" value="mstrWeb.5005"/> <!-- Print Subscriptions -->

        </mstrlayout:render>

        <span class="mstrIcon-inline">

         <mstrlayout:render name="userHelpAnchor">

          <mstrlayout:argument type="String" value="Print_on_schedule.htm"/>

         </mstrlayout:render>

        </span>

      </div>

     <mstrlayout:render name="subscriptionsByDeliveryMode">

       <mstrlayout:argument type="int" value="4"/>

     </mstrlayout:render>

29. Save your changes. 

30. Navigate to Pages->mySubs (My Subscriptions). 

31. Right-click mySubs (My Subscriptions) and select Duplicate->by making a copy of this page. The copy opens in the Basic Properties editor. 

32. Enter myDeliveries in the text field for Name. 

33. Remove the entry from the text field for Descriptor ID. Keep it blank. 

34. Enter My Deliveries in the text field for Descriptor. 

35. Save your changes. 

36. Navigate to Beans->allSubscriptions (Type=SubscriptionFolderBean). 

37. Double-click allSubscriptions (Type=SubscriptionFolderBean) to launch the Bean Properties editor. 

38. Update the value of the initialization property deliveryMode to 7. 

39. Click Bean Styles. 

40. Click Add below the list of styles available. 

41. Select DSDeliveriesListStyle and click >>. 

42. Click OK. 

43. Click the Template Properties tab at the bottom. 

44. Select allSubscriptions in the Display Components section and click Edit. This launches the Display Web GUI Component Wizard. 

45. Click Next. 

46. Do not make any changes to the features and click Next. 

47. Enter DSDeliveriesListStyle in text field for Style associated to this component. 

48. Clear the check box From Preference. 

49. Click Next. 

50. Click Finish. 

51. Save your changes. 

52. Navigate to Pages->mySubs (My Subscriptions)->Beans->allSubscriptions (Type=SubscriptionFodlerBean). 

53. Double-click allSubscriptions (Type=SubscriptionFodlerBean) to launch the Bean Properties editor. 

54. Update the value of the initialization property deliveryMode to 144. 

55. Save your changes. 

56. Navigate to Pages->-1 (Default Page). 

57. Double-click the -1 (Default Page) page to launch the Basic Properties editor. 

58. Click the Template Properties tab at the bottom in the right frame to make changes to the Default page template. 

59. Click Edit Shortcuts. 

60. Select the radio button for Add New Shortcut. 

61. Click Next. 

62. Enter deliveries in the Name text field. 

63. Enter My Deliveries in the Descriptor text field. 

64. Click Modify next to the text field for Display this menu item only if the following feature(s) is(are) available. 

65. Select scheduling, scheduled-email, scheduled-file-export, and scheduled-print, and click >>. 

66. Click OK. 

67. Click Add Event in the Events section. 

68. To select the event enumeration class, click Browse and enter EnumServletEvents. 

69. Select EnumServletEvents from your project and click OK. 

70. Select  WebEventOpenPage from the drop-down menu for Event to trigger when menu element is selected. 

71. Click Add in the EventsArguments section. 

72. Select WebEventArgumentTarget from the drop-down menu and click OK. 

73. Enter myDeliveries in the Argument Value text field. 

74. Click OK. 

75. Click Next. 

76. Click Finish. 

77. Save your changes. 

78. Click OK in the Refresh Application window to refresh the view. 

79. 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. 

80. Click on Pages to expand the list of pages used in MicroStrategy Web. 

81. Double-click the -1 (Default Page) page to launch the Basic Properties editor. 

82. Click the Template Properties tab at the bottom in the right frame to make changes to the Default page template. 

83. Click Edit Shortcuts. 

84. Select the radio button for Rearrange Shortcuts. 

85. Click Next. 

86. Select deliveries from the list of shortcuts and use the upwards pointing arrow to position it just after the subscriptions shortcut. 

87. Click Next. 

88. Click Finish. 

89. Save your changes. 

90. Click OK in the Refresh Application window to refresh the view. 

91. Navigate to Pages->myDeliveries (My Deliveries). 

92. Double-click the myDeliveries (My Deliveries) page to launch the Basic Properties editor. 

93. Click the Template Properties tab at the bottom in the right frame to make changes to the Default page template. 

94. Click Edit Shortcuts. 

95. Select the radio button for Rearrange Shortcuts. 

96. Click Next. 

97. Select deliveries from the drop-down menu for Selected shortcut. 

98. Click Next. 

99. Click Finish. 

100. Save your changes. 

101. Launch MicroStrategy Web to view the customization.