What's new in the Embedding SDK

In each release, changes are made to make the MicroStrategy SDK more powerful and easier to use.

MicroStrategy ONE September 2024

• Embed MicroStrategy dashboard consumption page.

  • Introduce enablePageSelection property to customize displaying page selectors in the TOC panel of Microstrategy dashboard consumption page.

• The customized UI settings in Embedding SDK.

  • Introduce customUi object property dockedToc to customize default values of isOpen and isDocked of the TOC panel in the UI of Microstrategy dashboard consumption page.

• Embed Dashboard Visualizations with Native Embedding SDK.

  • Introduce AbortController support to cancel MstrDossier.refresh() calls.

• Native Embedding MstrEnvironment Class

  • Introduce optional applicationId input parameter for MstrEnvironment.loadDossier() and MstrEnvironment.loadBot().
  • Introduce MstrEnvironment.getAuthToken() function.

• Properties for an embedded MicroStrategy Library home page.

  • Change the available values of currentPage.key according to the Library UI change and new API functionalities: Remove 'all', 'myContent', 'favorites' and 'recents'; add 'home' and 'contentDiscovery'.

MicroStrategy ONE June 2024

• Embed MicroStrategy bot consumption page.
  • Deprecate botConsumption object property snapshot.enabled to customize UI of the bot consumption page.
  • Deprecate botConsumption object property topicsPanel.enabled to customize UI of the bot consumption page.
  • Introduce botConsumption object property aiBot to customize UI of the bot consumption page.
  • Introduce customUi object property theme to customize UI of Microstrategy Library including bot consumption page.
  • Introduce botConsumption boolean property disableHyper to customize if you want to disable hyper extension highlight service in bot consumption page.
• Bot consumption page APIs.
  • You can call new APIs on the bot consumption page to interact with Microstrategy bot.
• New dashboard consumption page APIs.
  • You can call the dashboard APIs via the embeddingContext.dossierConsumption object on a dashboard consumption page.
• A new embedding context API.
  • You can call the new API embeddingContext.goToPage(page) to navigate to an arbitrary page on the OOTB Library.
• New OAuth APIs for SAML and OIDC login.
  • You can call the new APIs to simplify the original SAML or OIDC workflow.

MicroStrategy One March 2024

• Rename 'dossier' into 'dashboard'.
• Embed Bot Visualizations with Native Embedding SDK.
  • You can use the new Embedding SDK APIs to embed the visualizations on a bot consumption page.

2021 Update 12

Embed MicroStrategy bot consumption page.

• You can use a new Embedding SDK API to embed a bot consumption page. The user also could do some UI customizations.

2021 Update 11

• Embed MicroStrategy dashboard consumption page.
  • You can use a new Embedding SDK API to embed a dashboard consumption page, in which we support the user to navigate between the dashboard and the homepage.
• Dashboard consumption page APIs.
  • You can call new APIs on the dashboard consumption page to get and set the selected components.

2021 Update 9

The Native Embedding SDK.

• You can use the Native Embedding SDK to embed visualizations from separate containers to improve performance.
• Users can interact with the embedded visualization.
• Users can use APIs to perform manipulations such as filtering.

2021 Update 8

• Embed MicroStrategy report page.
  • Users can embed MicroStrategy report consumption page.
  • Users can control the visibility of the navigation bar of the report consumption page.
• Ability to customize dashboard pages from embedding Library home page
• Ability to customize Library home page from embedding dashboard page

2021 Update 7

Embed MicroStrategy Library home page.

• Users can embed MicroStrategy Library home page and use any child page accessed from the sidebar.
• Users can control the visibility of the navigation bar and the sidebar of the library home page.

2021 Update 4

• Enhancements to authoring an embedded dashboard.
  • Control the display of items in the authoring toolbar.
  • Control the display of authoring panels.
  • Support for creating a new dashboard.
• Show or hide all entries for a subscription.

2021 Update 3

• Author an embedded dashboard.
• Enable the selection of attribute elements.

2021 Update 2

• Interact with panel stacks in dossiers.
• Embed a single visualization.

2021

• More updates in error handling.
• Apply multiple filters after a dashboard is rendered.
• Show or hide the shareDossier function.

2020 Update 3

Error handling.

2020 Update 2

A new method to remove an embedded dashboard.

2019

A new property, dossierFeature, allows you to customize dashboard features on the UI. Use the readOnly detailed property to enable or disable all context menus. This includes the visualization right-click context menu and the context menu on the top right of the visualization that includes such options as Export.

11.0

• A new property allows you to pass filters during dashboard execution.
• New properties allow you to customize features and the UI for an embedded dashboard.

10.9

The Embedding SDK was introduced in 10.9.

• This new SDK was added to the MicroStrategy Developer Library to support embedding MicroStrategy content in third-party web applications or portals.