Skip to content

Update #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2025
Merged

Update #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions docs/embedding-context/embedding-context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,14 @@ This API could be used to navigate to an arbitrary page on the OOTB Library.

#### Input Parameters

| Parameter Name | Data Type | Description | Is Required |
| ---------------------- | --------- | ----------------------------------------------- | ----------- |
| pageInfo.applicationId | string | The application ID, which must be a GUID. | false |
| pageInfo.projectId | string | The project ID, which must be a GUID. | false |
| pageInfo.objectId | string | The object ID, which must be a valid object id. | false |
| pageInfo.pageKey | string | The page key. | false |
| pageInfo.isAuthoring | boolean | Go to the authoring page or not. | false |
| Parameter Name | Data Type | Description | Is Required |
| ---------------------- | --------- | ------------------------------------------------------------ | ----------- |
| pageInfo.applicationId | string | The application ID, which must be a GUID. | false |
| pageInfo.projectId | string | The project ID, which must be a GUID. | false |
| pageInfo.objectId | string | The object ID, which must be a valid object id. | false |
| pageInfo.pageKey | string | The page key. | false |
| pageInfo.isAuthoring | boolean | Go to the authoring page or not. | false |
| pageInfo.instanceId | string | The instance id, which must be a valid dashboard instanceId. | false |

The API call like `embeddingContext.goToPage()` will navigate to the homepage.

Expand Down Expand Up @@ -142,6 +143,7 @@ try {
objectId: "EC70648611E7A2F962E90080EFD58751",
pageKey: "W69",
isAuthoring: false,
instanceId: "A3B45ED63F49EE11FE53CA946299FC7C",
});
} catch (err) {
// The other error handling logic here
Expand All @@ -160,4 +162,4 @@ The case "the input parameter fails input validation" contains:

- The field value's data type isn't right
- `objectId` and `projectId` don't exist at the same time
- `pageKey`, `isAuthoring` appears when `objectId` and `projectId` don't exist
- `pageKey`, `isAuthoring`, `instanceId` appears when `objectId` and `projectId` don't exist
5 changes: 5 additions & 0 deletions docs/whats-new-in-the-embedding-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ 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.

## Strategy ONE August 2025

- [Support Dashboard Instance Id in goToPage()](./embedding-context/#gotopagepageinfo)
- Support to input the dashboard instance id in the API `EmbeddingContext.goToPage()` in iframe Embedding SDK.

## Strategy ONE July 2025

- [Get the dashboard instance ID](./native-embedding-architecture/dossier-info-api#get-dashboard-instance-id)
Expand Down