EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB320020: Automatically Trigger the "Add Existing Dataset" Panel When a New Visual Insight Dashboard Is Created using MicroStrategy SDK 10.5


Community Admin

• Strategy


A developer may need to know the number of datasets within a Visual Insight Dashboard.  One use case is to determine if a Visual Insight Dashboard is new.  Assuming that a new Dashboard will contain 0 datasets, developers can insert logic to enable panels such as the "Add Existing Dataset" panel when a Dashboard has 0 datasets. This is a javascript customization.

SUMMARY:
A developer may need to know the number of datasets within a Visual Insight Dashboard.  One use case is to determine if a Visual Insight Dashboard is new.  Assuming that a new Dashboard will contain 0 datasets, developers can insert logic to enable panels such as the "Add Existing Dataset" panel when a Dashboard has 0 datasets.  
 
CUSTOMIZATION SUMMARY:
To achieve this customization, developers can leverage JavaScript and the Strategy SDK.  The following JavaScript snippet will return 0 if no datasets are attached to the current Visual Insight Dashboard: 


Object.keys(mstrApp.rootCtrl.view.controller.datasetsPanel.data).length

This JavaScript snippet returns the number of datasets already added to this Strategy Visual Insight Dashboard.
The following JavaScript snippet will trigger the "add existing dataset" panel when executed on the Strategy Visual Insight page (Html5Vi):

mstrApp.rootCtrl.view.controller.docCtrl.addDataset()

 
CUSTOMIZATION STEPS:

  1. Launch the Strategy Web Customization Editor
  2. Create a new plugin, give a meaningful name
  3. Navigate to Strategy Web Configuration-> Pages -> Html5Vi(HTML5 VI Page) -> JavaScript.
  4. Right-click on the JavaScript folder and choose "Create New Javascript".
  5. Use the following snippet:
    
    if(Object.keys(mstrApp.rootCtrl.view.controller.datasetsPanel.data).length == 0){
    	console.log("Dashboard doesn't seem to have existin datasets, since count is 0. Triggering logic to prompt user to add existing dataset");
    	mstrApp.rootCtrl.view.controller.docCtrl.addDataset();
    }

  6. Save the JavaScript, restart Strategy Web and clear browser caches to apply the customization.

  
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.Strategy.com).
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@Strategy.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.Strategy.com/us/services/support/contact.
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.


Comment

0 comments

Details

Knowledge Article

Published:

March 30, 2017

Last Updated:

May 9, 2017