` as the placeholder where you want to embed the Library home page.
@@ -36,6 +36,6 @@ To help you get started, we have provided a number of simple applications with s
Describes the properties that can be set for an embedded MicroStrategy Library home page.
-- [Library page APIs](./library-page-apis.md)
+- [Library page APIs](../embedding-context/library-page-apis.md)
Describes which Embedding SDK APIs are available on the MicroStrategy Library home page.
diff --git a/docs/embed-library-main-page/embed-library-properties.md b/docs/embed-library-main-page/embed-library-properties.md
index 248b5c7..baa9f4c 100644
--- a/docs/embed-library-main-page/embed-library-properties.md
+++ b/docs/embed-library-main-page/embed-library-properties.md
@@ -325,33 +325,6 @@ The special behaviors are as below:
- If sidebar is disabled in the application settings, whether setting `customUi.library.sidebar.show` to true or false, the sidebar couldn't be shown.
- If the navigation bar is enabled in `customUi.library.navigationBar.enabled` and application settings, and "Collapse toolbar by default" is enabled by default, when `customUi.library.sidebar.show` is true, the navigation bar would be expanded and shown.
-### `libraryItemSelectMode`
-
-Specifies the library item select mode on the embedded pages, including grid and list views.
-
-#### Required?
-
-No
-
-#### Default value
-
-N/A
-
-#### Allowed values
-
-- single
-- multiple
-
-#### Sample
-
-```js
-microstrategy.embeddingContexts.embedLibraryPage({
- placeholder: placeholderDiv,
- serverUrl: "http://{host}:{port}/{Library}",
- libraryItemSelectMode: "single",
-});
-```
-
### `currentPage`
Specifies the page on the sidebar entries that you want to embed.
diff --git a/docs/embed-report-page/embed-report-page.md b/docs/embed-report-page/embed-report-page.md
index 30e10c2..c534fa1 100644
--- a/docs/embed-report-page/embed-report-page.md
+++ b/docs/embed-report-page/embed-report-page.md
@@ -13,7 +13,7 @@ There are three basic steps for embedding a MicroStrategy report page.
```
- Replace `{YOUR_LIBRARY_SERVER_URL}` with your actual MicroStrategy Library Server URL, e.g.,
.
+ Replace `{YOUR_LIBRARY_SERVER_URL}` with your actual MicroStrategy Library Server URL, e.g., [https://demo.microstrategy.com/MicroStrategyLibrary](https://demo.microstrategy.com/MicroStrategyLibrary).
1. Create a `` as the placeholder where you want to embed the report.
@@ -26,6 +26,8 @@ There are three basic steps for embedding a MicroStrategy report page.
```js
microstrategy.embeddingContexts.embedReportPage({
serverUrl: "{YOUR_LIBRARY_SERVER_URL}",
+ projectId: "{YOUR_PROJECT_ID}",
+ objectId: "{YOUR_OBJECT_ID}",
placeholder: document.getElementById("reportContainer"),
});
```
diff --git a/docs/embed-report-page/embed-report-properties.md b/docs/embed-report-page/embed-report-properties.md
index bffccaf..300f875 100644
--- a/docs/embed-report-page/embed-report-properties.md
+++ b/docs/embed-report-page/embed-report-properties.md
@@ -175,7 +175,7 @@ The `getLoginToken` function can be found in [the `getLoginToken` doc](../add-fu
```js
microstrategy.embeddingContexts.embedReportPage({
placeholder: placeholderDiv,
- serverUrl: "https://{host}:{port}/{Library}",
+ serverUrl: "https://demo.microstrategy.com/MicroStrategyLibrary",
projectId: "B19DEDCC11D4E0EFC000EB9495D0F44F",
objectId: "A409D6EC2245D4417C4FBEA5CD87D3A1",
enableCustomerAuthentication: true,
diff --git a/docs/embedding-context/dossier-consumption-page-apis.md b/docs/embedding-context/dossier-consumption-page-apis.md
new file mode 100644
index 0000000..aa2535c
--- /dev/null
+++ b/docs/embedding-context/dossier-consumption-page-apis.md
@@ -0,0 +1,192 @@
+---
+title: Dossier consumption page APIs
+description: Describes which Embedding SDK APIs are available on the MicroStrategy dossier consumption page.
+---
+
+The `dossierConsumption` object is the manipulator of the MicroStrategy dossier consumption page. It could be got by `embeddingContext.dossierConsumption`.
+
+The details of the `embeddingContext` object could be seen in [Embedding context](./embedding-context.md).
+
+The APIs under Library page object are as below.
+
+## Dossier consumption page APIs
+
+### `getDossierDefinition()`
+
+#### Description
+
+This API is used for getting the dossier definition. Its result contains the dossier id, name, project id and TOC information.
+
+#### Class
+
+`DossierConsumption`
+
+#### Return type
+
+This API would return a Promise object that resolves to an object that contains the dossier definition. Its serialized JSON string is as below:
+
+```json
+{
+ "id": "EC5441154009D3C39D5BD6AD75865EF4",
+ "name": "DDA_Dossier_filter_SearchBox_style",
+ "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
+ "chapters": [
+ {
+ "key": "K36",
+ "name": "Chapter 1",
+ "pages": [
+ {
+ "key": "K53",
+ "name": "Page 1"
+ },
+ {
+ "key": "W78",
+ "name": "Page 2"
+ }
+ ]
+ }
+ ]
+}
+```
+
+If the API encounters an error in its executing process, the error would be thrown and could be caught.
+
+#### Example
+
+```js
+try {
+ const dossierDefinition = await embeddingContext.dossierConsumption.getDossierDefinition();
+} catch (err) {
+ // The error handling logic here
+ console.error(err);
+}
+```
+
+### `selectComponents(componentKeys)`
+
+#### Description
+
+This API could be used to select visualizations or groups on a dossier consumption page.
+
+#### Class
+
+`DossierConsumption`
+
+#### Input Parameters
+
+- `componentKeys`:
+
+ **Data Type**
+
+ `array`
+
+ **Required?**
+
+ Yes
+
+#### Return type
+
+This API would return a Promise object that resolves to void. If it encounters an error in its executing process, the error would be thrown and could be caught.
+
+#### Example
+
+```js
+try {
+ const response = await embeddingContext.dossierConsumption.selectComponents([
+ "K53",
+ "53ACF03646491B5F5F5A7B83EB1BB0BE",
+ ]);
+} catch (err) {
+ // The other error handling logic here
+}
+```
+
+### `getSelectedComponents()`
+
+#### Description
+
+This API could be used to get currently selected visualizations and groups on a dossier consumption page.
+
+#### Class
+
+`DossierConsumption`
+
+#### Return type
+
+This API would return a Promise object that resolves to an object that contains the selected components. Its serialized JSON string is as below:
+
+```json
+{
+ "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
+ "dossierId": "EC5441154009D3C39D5BD6AD75865EF4",
+ "selectedComponents": [
+ {
+ "key": "K52",
+ "type": "visualization",
+ "chapterKey": "K36",
+ "pageKey": "K53"
+ },
+ {
+ "key": "53ACF03646491B5F5F5A7B83EB1BB0BE",
+ "type": "group",
+ "chapterKey": "K87",
+ "pageKey": "K67"
+ }
+ ]
+}
+```
+
+If the API encounters an error in its executing process, the error would be thrown and could be caught.
+
+#### Example
+
+```js
+try {
+ const selectedComponents = await embeddingContext.dossierConsumption.getSelectedComponents();
+} catch (err) {
+ // The other error handling logic here
+ console.error(err);
+}
+```
+
+### `getDossierInstanceId()`
+
+#### Description
+
+The API details are identical to [Dossier.getDossierInstanceId()](../add-functionality/methods-and-properties#dossiergetdossierinstanceid)
+
+### `getCurrentPageVisualizationList()`
+
+#### Description
+
+The API details are identical to [Dossier.getCurrentPageVisualizationList()](../add-functionality/add-nav#getcurrentpagevisualizationlist)
+
+### `changeVisualizationSize(props)`
+
+#### Description
+
+The API details are identical to [Dossier.changeVisualizationSize(props)](../add-functionality/embed-vis#1-change-the-visualization-size)
+
+### `getCurrentPagePanelStacks()`
+
+#### Description
+
+The API details are identical to [Dossier.getCurrentPagePanelStacks()](../add-functionality/panel-stacks#1-get-the-panel-stack-definitions-from-the-current-page)
+
+### `switchPanel(panelKey)`
+
+#### Description
+
+The API details are identical to [Dossier.switchPanel(panelKey)](../add-functionality/panel-stacks#2-switch-panels-on-the-current-page)
+
+### `getAvailableElements(vizKey)`
+
+#### Description
+
+The API details are identical to [Dossier.getAvailableElements(visKey)](../add-functionality/attribute-element-selection#api-for-getting-available-elements)
+
+### `selectVisualizationElements(props)`
+
+#### Description
+
+The API details are identical to [Dossier.selectVizElement(props)](../add-functionality/attribute-element-selection#api-for-attribute-element-selection-in-a-dossier)
diff --git a/docs/embedding-context/embedding-context.md b/docs/embedding-context/embedding-context.md
new file mode 100644
index 0000000..35084ad
--- /dev/null
+++ b/docs/embedding-context/embedding-context.md
@@ -0,0 +1,95 @@
+---
+title: Embedding context
+description: Describes the object that is used for manipulating the embeded pages in the whole embedding lifecycle.
+---
+
+The `embeddingContext` object a service object that would persist in the whole embedding lifecycle.
+
+The `embeddingContext` object could be created as below:
+
+```js
+try {
+ const embeddingContext = await microstrategy.embeddingContexts.embedLibraryPage({
+ serverUrl: "https://demo.microstrategy.com/MicroStrategyLibrary",
+ placeholder: document.getElementById("dossierContainer"),
+ });
+} catch (err) {
+ // Your custom error handling logic here
+}
+```
+
+The `embedLibraryPage()` function above can be replaced to the other functions under the `embeddingContexts` namespace, include:
+
+- `embedDossierConsumptionPage(props)`
+- `embedReportPage(props)`
+
+This `embeddingContext` object could be used when the user navigates between different types of pages. It has several fields:
+
+- `libraryPage`: used for call the APIs that interact with the Library homepage. The detailed APIs could be seen in [Library page APIs](./library-page-apis.md)
+- `dossierConsumption`: used for call the APIs that interact with the dossier consumption page. The detailed APIs could be seen in [Dossier consumption page APIs](./dossier-consumption-page-apis.md)
+
+If the current embedded page is the Library homepage, and the user uses the manipulation object of the other pages, like `embeddingContext.dossierConsumption` to call the APIs of the other page, there would be an error.
+
+Besides the APIs on different types of pages, there are still some APIs that could be used on all kinds of pages, so we put them under the `embeddingContext` object. Include:
+
+## Embedding context APIs
+
+### `registerEventHandler(evtName, handler)`
+
+#### Class
+
+`EmbeddingContext`
+
+#### Description
+
+See the identical function in [Event handlers](../add-functionality/add-event#registereventhandlerevtname-handler).
+
+### `removeEventHandler(evtName, handler)`
+
+#### Class
+
+`EmbeddingContext`
+
+#### Description
+
+See the identical function in [Event handlers](../add-functionality/add-event#removeeventhandlerevtname-handler).
+
+### `addCustomErrorHandler(handler, showErrorPopup)`
+
+#### Class
+
+`EmbeddingContext`
+
+#### Description
+
+See the identical function in [Custom error handling after dossier creation](../add-functionality/error-handling#custom-error-handling-after-dossier-creation).
+
+### `removeCustomErrorHandler()`
+
+#### Class
+
+`EmbeddingContext`
+
+#### Description
+
+See the identical function in [Custom error handling after dossier creation](../add-functionality/error-handling#custom-error-handling-after-dossier-creation).
+
+### `addSessionErrorHandler(handler)`
+
+#### Class
+
+`EmbeddingContext`
+
+#### Description
+
+See the identical function in [Session error handling after dossier creation](../add-functionality/error-handling#session-error-handling-after-dossier-creation).
+
+### `removeSessionErrorhandler()`
+
+#### Class
+
+`EmbeddingContext`
+
+#### Description
+
+See the identical function in [Session error handling after dossier creation](../add-functionality/error-handling#session-error-handling-after-dossier-creation).
diff --git a/docs/embed-library-main-page/library-page-apis.md b/docs/embedding-context/library-page-apis.md
similarity index 64%
rename from docs/embed-library-main-page/library-page-apis.md
rename to docs/embedding-context/library-page-apis.md
index 715f703..3eec51e 100644
--- a/docs/embed-library-main-page/library-page-apis.md
+++ b/docs/embedding-context/library-page-apis.md
@@ -5,45 +5,7 @@ description: Describes which Embedding SDK APIs are available on the MicroStrate
The `LibraryPage` object is the manipulator of the MicroStrategy Library home page. It could be got by `embeddingContext.libraryPage`.
-The `embeddingContext` object could be created as below:
-
-```js
-try {
- const embeddingContext = await microstrategy.embeddingContexts.embedLibraryPage({
- serverUrl: "{YOUR_LIBRARY_SERVER_URL}",
- placeholder: document.getElementById("dossierContainer"),
- });
- // An example to call the LibraryPage APIs
- const myGroups = await embeddingContext.libraryPage.getAllMyGroups();
-} catch (err) {
- // Your custom error handling logic here
-}
-```
-
-This object is actually a service object that would persist in the embedding context. So if the user goes to a dossier page from the home page, then return to the home page again, this object could still be used.
-
-If the user wants to use the APIs below to manipulate the Library home page when he embeds a dossier page by `microstrategy.dossier.create()` at first, he could do the following things:
-
-- Click the "Go to Library" icon on the page to navigate to the Library home page;
-- Call `Dossier.getEmbeddingContext()` to get the EmbeddingContext object;
-- Use the EmbeddingContext object to call Library home page APIs.
-
-A piece of example code could be like this:
-
-```js
-try {
- const dossier = await microstrategy.dossier.create({
- url: "{YOUR_DOSSIER_URL}",
- placeholder: document.getElementById("dossierContainer"),
- });
- // ... Some manual actions to go to the Library home page
- const embeddingContext = dossier.getEmbeddingContext();
- // Use some Library home page APIs
- const myGroups = await embeddingContext.libraryPage.getAllMyGroups();
-} catch (err) {
- // Your custom error handling logic here
-}
-```
+The details of the `embeddingContext` object could be seen in [Embedding context](./embedding-context.md).
The APIs under Library page object are as below.
diff --git a/docs/index.md b/docs/index.md
index 167de96..b48373e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -14,7 +14,7 @@ There are three basic steps for embedding a dossier.
```
- Replace `{YOUR_LIBRARY_SERVER_URL}` with your actual MicroStrategy Library Server URL, e.g., .
+ Replace `{YOUR_LIBRARY_SERVER_URL}` with your actual MicroStrategy Library Server URL, e.g., [https://demo.microstrategy.com/MicroStrategyLibrary](https://demo.microstrategy.com/MicroStrategyLibrary).
:::tip
diff --git a/docs/support-for-different-authentication-environments/guest-authentication-mode-only.md b/docs/support-for-different-authentication-environments/guest-authentication-mode-only.md
index 87c93bb..b1915b7 100644
--- a/docs/support-for-different-authentication-environments/guest-authentication-mode-only.md
+++ b/docs/support-for-different-authentication-environments/guest-authentication-mode-only.md
@@ -9,7 +9,7 @@ To help you get started, we have provided [a live example](https://microstrategy
We have provided simple instructions and code snippets to help you configure the example to use a dossier from your MicroStrategy Library Server. If you customize the example, however, you must configure your Library Server to support only Guest authentication.
-Please also check out the examples in [Embedding SDK Playground](https://microstrategy.github.io/playground/) from the "Start over" button and .
+Please also check out the examples in [Embedding SDK Playground](https://microstrategy.github.io/playground/) from the "Start over" button and [https://microstrategy.github.io/embedding-sdk-samples](https://microstrategy.github.io/embedding-sdk-samples).
```html
diff --git a/docs/whats-new-in-the-embedding-sdk.md b/docs/whats-new-in-the-embedding-sdk.md
index ed4d238..e7fd998 100644
--- a/docs/whats-new-in-the-embedding-sdk.md
+++ b/docs/whats-new-in-the-embedding-sdk.md
@@ -5,11 +5,19 @@ description: In each release, changes are made to make the MicroStrategy SDK mor
In each release, changes are made to make the MicroStrategy SDK more powerful and easier to use.
-## 2021 Update 11(September 2023)
+## 2021 Update 12
-- [Event handlers added to Library for; item selection, and menu selection.](./add-functionality/add-event.md)
+- [Embed MicroStrategy bot consumption page](./embed-bot-consumption-page/embed-bot-consumption-page.md)
+ - You can use a new Embedding SDK API to embed a bot consumption page. The user also could do some UI customizations.
-## 2021 Update 9 (May 2023)
+## 2021 Update 11
+
+- [Embed MicroStrategy dossier consumption page](./embed-dossier-consumption-page/embed-dossier-consumption-page.md)
+ - You can use a new Embedding SDK API to embed a dossier consumption page, in which we support the user to navigate between the dossier and the homepage.
+- [Dossier consumption page APIs](./embedding-context/dossier-consumption-page-apis.md)
+ - You can call new APIs on the dossier consumption page to get and set the selected components.
+
+## 2021 Update 9
[Native Embedding SDK](./native-embedding-architecture/native-embedding-architecture.md)
@@ -17,15 +25,11 @@ In each release, changes are made to make the MicroStrategy SDK more powerful an
- Users can interact with the embedded visualization.
- Users can use APIs to perform manipulations such as filtering.
-## 2021 Update 8 (February 2023)
-
-[Embed MicroStrategy report page.](./embed-report-page/embed-report-page.md)
-
-- Users can embed MicroStrategy report consumption page.
-- Users can control the visibility of the navigation bar of the report consumption page.
-
## 2021 Update 8
+- [Embed MicroStrategy report page.](./embed-report-page/embed-report-page.md)
+ - Users can embed MicroStrategy report consumption page.
+ - Users can control the visibility of the navigation bar of the report consumption page.
- [Ability to customize dossier pages from embedding Library home page](./embed-library-main-page/embed-custom-ui-on-all-pages.md)
- [Ability to customize Library home page from embedding dossier page](./add-functionality/methods-and-properties.md#customui)
diff --git a/sidebars.js b/sidebars.js
index 7dbc448..57d0382 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -66,10 +66,27 @@ const sidebars = {
label: "Embed MicroStrategy Library home page",
items: [
"embed-library-main-page/embed-library-properties",
- "embed-library-main-page/library-page-apis",
"embed-library-main-page/embed-custom-ui-on-all-pages",
],
},
+ {
+ type: "category",
+ link: {
+ type: "doc",
+ id: "embed-dossier-consumption-page/embed-dossier-consumption-page",
+ },
+ label: "Embed MicroStrategy dossier consumption page",
+ items: ["embed-dossier-consumption-page/embed-dossier-consumption-properties"],
+ },
+ {
+ type: "category",
+ link: {
+ type: "doc",
+ id: "embed-bot-consumption-page/embed-bot-consumption-page",
+ },
+ label: "Embed MicroStrategy bot consumption page",
+ items: ["embed-bot-consumption-page/embed-bot-consumption-properties"],
+ },
{
type: "category",
link: {
@@ -79,6 +96,18 @@ const sidebars = {
label: "Embed MicroStrategy report page",
items: ["embed-report-page/embed-report-properties"],
},
+ {
+ type: "category",
+ link: {
+ type: "doc",
+ id: "embedding-context/embedding-context",
+ },
+ label: "Embedding context",
+ items: [
+ "embedding-context/library-page-apis",
+ "embedding-context/dossier-consumption-page-apis",
+ ],
+ },
{
type: "category",
link: {