Update (#29)

Co-authored-by: ziyuhehe <[email protected]>

Author: ziyuhehe

CONTRIBUTING.md

@@ -10,7 +10,7 @@
   - [Open a pull request](#open-a-pull-request)
   - [Submit your PR & get it reviewed](#submit-your-pr--get-it-reviewed)
   - [Your PR is merged](#your-pr-is-merged)
-  - [Keep contributing as you use MicroStrategy Docs](#keep-contributing-as-you-use-microstrategy-docs)
+  - [Keep contributing as you use Strategy Docs](#keep-contributing-as-you-use-strategy-docs)
 
 ## Getting started
 
@@ -21,7 +21,7 @@ Before you begin:
 
 ### Use the 'Edit' button
 
-Navigating a new codebase can be challenging, so we're making that a little easier. As you're using this MicroStrategy Embedding SDK Docs, you may come across an article that you want to make an update to. You can find and click the **Edit** button on the top right corner on that article, which will take you to the file in this repo where you'll make your changes.
+Navigating a new codebase can be challenging, so we're making that a little easier. As you're using this Strategy Embedding SDK Docs, you may come across an article that you want to make an update to. You can find and click the **Edit** button on the top right corner on that article, which will take you to the file in this repo where you'll make your changes.
 
 Before you make your changes, check to see if an [issue exists](https://github.com/MicroStrategy/embedding-sdk-docs/issues) already for the change you want to make.
 
@@ -44,7 +44,7 @@ Fork using GitHub Desktop:
 
 ### Make your update
 
-Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-microstrategyembedding-sdk-docs-repository).
+Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-strategyembedding-sdk-docs-repository).
 
 - Are you making changes to the application code? You'll need **Node.js v16** to run the site locally. See [contributing/development.md](contributing/development.md).
 - Are you contributing to markdown? We use [Markdown](https://www.markdownguide.org/basic-syntax/).
@@ -60,13 +60,13 @@ When you're done making changes and you'd like to propose them for review, use t
 
 ### Your PR is merged
 
-Congratulations! The whole MicroStrategy community thanks you. :sparkles:
+Congratulations! The whole Strategy community thanks you. :sparkles:
 
 Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/MicroStrategy/embedding-sdk-docs/graphs/contributors) and at the bottom of the page you contributed to.
 
-### Keep contributing as you use MicroStrategy Docs
+### Keep contributing as you use Strategy Docs
 
-Now that you're a part of the MicroStrategy Docs community, you can keep participating in many ways.
+Now that you're a part of the Strategy Docs community, you can keep participating in many ways.
 
 **Learn more about contributing:**
 
@@ -77,7 +77,7 @@ Now that you're a part of the MicroStrategy Docs community, you can keep partici
   - [:earth_asia: Translations](#earth_asia-translations)
 - [Starting with an issue](#starting-with-an-issue)
 - [Opening a pull request](#opening-a-pull-request)
-  - [Working in the MicroStrategy/embedding-sdk-docs repository](#working-in-the-microstrategyembedding-sdk-docs-repository)
+  - [Working in the Strategy/embedding-sdk-docs repository](#working-in-the-strategyembedding-sdk-docs-repository)
   - [Reviewing](#reviewing)
     - [Self review](#self-review)
     - [Test it locally](#test-it-locally)
@@ -87,7 +87,7 @@ Now that you're a part of the MicroStrategy Docs community, you can keep partici
 
 ## :memo: Types of contributions
 
-You can contribute to the MicroStrategy Embedding SDK Docs content and site in several ways. This repo is a place to discuss and collaborate on MicroStrategy Embedding SDK Docs! Our small, but mighty :muscle: docs team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
+You can contribute to the Strategy Embedding SDK Docs content and site in several ways. This repo is a place to discuss and collaborate on Strategy Embedding SDK Docs! Our small, but mighty :muscle: docs team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
 
 ### :beetle: Issues
 
@@ -101,7 +101,7 @@ When we merge those changes, they should be deployed to the live site within 24
 
 ### :question: Support
 
-We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with MicroStrategy, unrelated to our documentation, please [contact MicroStrategy Support directly](https://www.microstrategy.com/support). Any issues, or pull requests opened here requesting support will be given information about how to contact MicroStrategy Support, then closed and locked.
+We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with Strategy, unrelated to our documentation, please [contact Strategy Support directly](https://www.microstrategy.com/support). Any issues, or pull requests opened here requesting support will be given information about how to contact Strategy Support, then closed and locked.
 
 ### :earth_asia: Translations
 
@@ -117,16 +117,16 @@ You can browse existing issues to find something that needs help!
 
 You can use the GitHub user interface :pencil2: for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
 
-## Working in the MicroStrategy/embedding-sdk-docs repository
+## Working in the Strategy/embedding-sdk-docs repository
 
 Here's some information that might be helpful while working on a Docs PR:
 
 - [Development](contributing/development.md) - This short guide describes how to get this app running on your local machine.
-- [Content style guide for MicroStrategy Docs](contributing/content-style-guide.md) - This guide covers information about how we style our content and images. It also links to the resources we use for general style guidelines.
+- [Content style guide for Strategy Docs](contributing/content-style-guide.md) - This guide covers information about how we style our content and images. It also links to the resources we use for general style guidelines.
 
 ## Reviewing
 
-We (usually the docs team, but sometimes MicroStrategy product managers, engineers, or supportocats too!) review every single PR. The purpose of reviews is to create the best content we can for people who use MicroStrategy.
+We (usually the docs team, but sometimes Strategy product managers, engineers, or supportocats too!) review every single PR. The purpose of reviews is to create the best content we can for people who use Strategy.
 
 :yellow_heart: Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
 

README.md

@@ -53,6 +53,6 @@ If you have a solution to one of the open issues, you will need to fork the repo
 
 #### And that's it
 
-That's how you can get started easily as a member of the MicroStrategy Embedding SDK Documentation community. :sparkles:
+That's how you can get started easily as a member of the Strategy Embedding SDK Documentation community. :sparkles:
 
 If you want to know more, or you're making a more complex contribution, check out [Getting Started with Contributing](CONTRIBUTING.md).

contributing/content-style-guide.md

@@ -138,7 +138,7 @@ The list below shows the usage of emojis in our Docs site:
 
 - Titles, sidebar labels, and headers
 
-  - These should use **sentence case**. For example, prefer "This is the title from MicroStrategy" over "This Is The Title From MicroStrategy".
+  - These should use **sentence case**. For example, prefer "This is the title from Strategy" over "This Is The Title From Strategy".
   - `sidebar_label` should only be used if you want a different title in the sidebar than the `title` in front matter. (Note: For folders, `label` in sidebars.js takes priority over `sidebar_label`)
 
 ## Tables

docs/add-functionality/add-event.md

@@ -15,7 +15,7 @@ Once you have used the `dossier.create(props)` method to embed a dashboard into
 
 ## Events
 
-Each supported event is described in the table below. You get the EventType from `microstrategy.dossier.EventType`.
+Each supported event is described in the table below. You get the EventType from `microstrategy.dossier.EventType` or `microstrategy.embeddingContexts.EventType`.
 
 ### onGraphicsSelected
 
@@ -391,7 +391,8 @@ embedDossier.registerEventHandler(EventType.ON_LIBRARY_ITEM_SELECTED, libraryIte
     "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
     "name": "Distribution Center & Brands",
     "type": 55,
-    "subtype": null
+    "subtype": null,
+    "isDocument": false
   }
 ]
 ```
@@ -570,6 +571,40 @@ embedDossier.registerEventHandler(EventType.ON_DOSSIER_INSTANCE_CHANGED, (conten
 }
 ```
 
+### onInstanceChanged
+
+#### Event enumeration
+
+`EventType.ON_INSTANCE_CHANGED`
+
+#### Description
+
+Raised when the a new object instance is created or destroyed. The object type could be a dashboard, document, report or bot.
+
+#### Content
+
+The event callback parameters contain the project id, object id, object type, object name, and the instance id.
+
+#### Code example
+
+```js
+embedDossier.registerEventHandler(EventType.ON_INSTANCE_CHANGED, (content) => {
+  // Use the content here
+});
+```
+
+#### Content example
+
+```json
+{
+  "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
+  "objectId": "D9AB379D11EC92C1D9DC0080EFD415BB",
+  "objectName": "Dashboard Prompted on Category",
+  "objectType": "dossier",
+  "instanceId": "EC003BC7A046E75DE83373A254824F20"
+}
+```
+
 ### onComponentSelectionChanged
 
 #### Event enumeration
@@ -598,6 +633,8 @@ embedDossier.registerEventHandler(EventType.ON_COMPONENT_SELECTION_CHANGED, (con
 {
   "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
   "dossierId": "EC5441154009D3C39D5BD6AD75865EF4",
+  "objectId": "EC5441154009D3C39D5BD6AD75865EF4",
+  "objectType": "dossier",
   "selectedComponents": [
     {
       "key": "K52",

docs/add-functionality/add-functionality.md

@@ -43,11 +43,11 @@ Once you have embedded a dashboard, you can use helper methods in the Embedding
 
 :::tip
 
-If you plan to use Embedding SDK on a web page on a different domain from your MicroStrategy environment, please also meet the following requirements. More information in
+If you plan to use Embedding SDK on a web page on a different domain from your Strategy environment, please also meet the following requirements. More information in
 
 1. [Enable Cross-Origin Resource Sharing (CORS)](../config.md)
 1. [Allow SameSite cookies](../config.md#allow-samesite-cookies)
 
-If you plan to use Embedding SDK on the same domain as your MicroStrategy, the above changes are not required.
+If you plan to use Embedding SDK on the same domain as your Strategy, the above changes are not required.
 
 :::

docs/add-functionality/authoring-library.md

@@ -3,7 +3,7 @@ title: Author an embedded dashboard
 description: To allow users to conveniently edit a dashboard, Embedding SDK allows embedding a dashboard in the authoring mode, whether it is during the initial load or in the view mode of the dashboard.
 ---
 
-Embedding MicroStrategy content within critical business applications empowers users to make smarter decisions by taking advantage of the dashboard development efforts that occur behind the scenes. To allow users to conveniently edit a dashboard, Embedding SDK allows embedding a dashboard in the authoring mode, whether it is during the initial load or in the view mode of the dashboard.
+Embedding Strategy content within critical business applications empowers users to make smarter decisions by taking advantage of the dashboard development efforts that occur behind the scenes. To allow users to conveniently edit a dashboard, Embedding SDK allows embedding a dashboard in the authoring mode, whether it is during the initial load or in the view mode of the dashboard.
 
 :::tip
 

docs/add-functionality/error-handling.md

@@ -1,15 +1,15 @@
 ---
 title: Error handling
-description: MicroStrategy provides custom error handling in two stages, during dashboard creation and after dashboard creation.
+description: Strategy provides custom error handling in two stages, during dashboard creation and after dashboard creation.
 ---
 
 By default, Library displays a pop-up dialog when an error occurs, such as when a dataset is not found.
 
 ![library server error](../images/library_server_error.png)
 
-MicroStrategy provides custom error handling for these kinds of pop-up errors in two stages.
+Strategy provides custom error handling for these kinds of pop-up errors in two stages.
 
-MicroStrategy also provides session error handling for session errors in two stages. Because the handling method of the session error is different from other errors, we don't use the custom error handling in this case.
+Strategy also provides session error handling for session errors in two stages. Because the handling method of the session error is different from other errors, we don't use the custom error handling in this case.
 
 ## Custom error handling
 
@@ -67,11 +67,11 @@ microstrategy.dossier
   });
 ```
 
-### The overall MicroStrategy Library error behavior in embed case
+### The overall Library error behavior in embed case
 
 The error generated by the embedded Library or dashboard page would output an error log in the browser console. Besides that,
 
-- If `disableCustomErrorHandlerOnCreate` is set to `true` in `microstrategy.dossier.create` or `microstrategy.embeddingContexts.embedLibraryPage`, the custom error handler couldn't be registered. The error would only be shown by a popup error dialog, which is the same as the OOTB MicroStrategy Library behavior;
+- If `disableCustomErrorHandlerOnCreate` is set to `true` in `microstrategy.dossier.create` or `microstrategy.embeddingContexts.embedLibraryPage`, the custom error handler couldn't be registered. The error would only be shown by a popup error dialog, which is the same as the OOTB Library behavior;
 - If `disableCustomErrorHandlerOnCreate` is not set or is `false`:
   - If a custom error handler is set by `errorHandler` or `addCustomErrorHandler(customErrorHandler, false)`, the error would only invoke the custom error handler and wouldn't popup a Library error dialog.
   - If a custom error handler is set by `addCustomErrorHandler(customErrorHandler, true)`, the error would first popup an error dialog, and when the user clicks the button on the error dialog, the custom error handler would be invoked.
@@ -82,7 +82,7 @@ The error generated by the embedded Library or dashboard page would output an er
 When the session expiration error occurs:
 
 - If there is no `sessionErrorHandler` defined, the page will show the Library's logout page.
-- If you define a `sessionErrorHandler`, the function will be executed. After 1 minute, the page will forcefully redirect to the OOTB MicroStrategy Library login page.
+- If you define a `sessionErrorHandler`, the function will be executed. After 1 minute, the page will forcefully redirect to the OOTB Library login page.
 
 The differences from custom error handling: