MicroStrategy ONE

Adding a Conditional Shortcut to All Pages

The default hyperlinks are Create, Shared Reports, My Reports, History List, and My Subscriptions. In MicroStrategy Web, each of these links is defined as an individual shortcut that belongs to a shortcut list. Depending upon the requirements, you can add a new shortcut that is displayed on every page or only on a specific page or pages, or you can make the display of the link conditional, based on a Web Feature such as a user group or a project. You can further refine a conditional link so that it is either visible/hidden or enabled/disabled depending on whether the preference, privilege, or setting specified by the Web feature exists/does not exist.

In this customization scenario, you add a new shortcut MicroStrategy News to all the MicroStrategy Web Pages. This shortcut is displayed only to users who have administrative privileges— that is, only if they are a member of the "administrator" user group.

Before customization:

After customization:

 

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. 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 Pages to expand the list of pages used in MicroStrategy Web. 

  4. Double-click the -1 (Default Page) page. 

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

  6. Click Edit Shortcuts. 

  7. Select the radio button for Add New Shortcut. 

  8. Click Next. 

  9. Enter MicroStrategy News in the Name text field. 

  10. Enter MicroStrategy News in the Descriptor text field. 

  11. Enter http://www.microstrategy.com in the HRef text field.:

    Refer to Using the URL API to Access a MicroStrategy Web Page for instructions on creating a link that points to a new or existing MicroStrategy Web page.

  12. Enter _blank in the Target text field. 

  13. Select false from the drop-down menu for Append State.:

    If the shortcut points to a MicroStrategy Web page such as a Report Execution page, Document Execution page, etc. where you want to pass the state of a bean, keep theAppend Stateastrue.

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

  15. Select administrator and add this feature by clicking >>. 

  16. Click OK. 

  17. Click Next. 

  18. Click Finish. 

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

  20. Save your changes. 

  21. Launch MicroStrategy Web to view the customization.

See Also